Czy jest sens prezentować redundantną wersję dokumentacji?

Pracuję właśnie nad revampem strony t-regx.com, ma być odnowiona dokumentacja w różnych wersjach językowych i wersjonowana, i jestem już blisko końca, i się zorientowałem że mam możliwość zrobić coś dziwnego.

Dokumentacja jest napisana w .rts, potem ją parsuje na HTML'a i pokazuje na stronie. Przez to w jaki sposób jest napisana, mam możliwość wyrenderować ją też w innej postaci, np w readthedocs. Mógłbym wystawić domenę readthedocs.t-regx.com, i tam byłaby dokumentacja podobna do tej np: https://phpunit.readthedocs.io/en/9.5/test-doubles.html

I tak się zastanawiam czy to ma sens? Jeśli tak, to ktoś mógłby wybrać czy woli czytać dokumentację na mojej stronie, czy czy woli readthedocs.

Chociaż z drugiej strony, the readthedocs jako żę są znane, tak wydają się trochę outdated.

Co myślicie?

Trzymanie dokumentacji w gicie ma sens bo zawsze możesz dopisać do tego inne ci/cd, które to wyrenderuje inaczej. Masz historię zmian i jesteś niezależny od platformy. Możesz się przenieść na inną chmurę. Readthedocs nie jest outdated. Jest teraz po prostu dużo takich rozwiązań.

Z confluence już się nie zmigrujesz nigdzie indziej, albo będzie to ciężkie.

twoj_stary_pijany napisał(a):

Trzymanie dokumentacji w gicie ma sens bo zawsze możesz dopisać do tego inne ci/cd, które to wyrenderuje inaczej. Masz historię zmian i jesteś niezależny od platformy. Możesz się przenieść na inną chmurę.

Wszystko to samo mam w tej orginalnej dokumentacji bez readthedocs.

Nie ma sensu. Read the Docs to wg mnie jest dobry patent jeśli ktoś nie ma pomysłu na przejrzystą dokumentację, ale czy RTD wnosi jakąś wartość w stosunku do tego co teraz masz?

Hm, a czemu nie zrezygnować z normalnej dokumentacji i nie trzymać wszystkiego w RTD?
BTW dzięki za linka i informacje jak ta dokumentacja (format dokumentacji) się nazywa

KamilAdam napisał(a):

Hm, a czemu nie zrezygnować z normalnej dokumentacji i nie trzymać wszystkiego w RTD?
BTW dzięki za linka i informacje jak ta dokumentacja (format dokumentacji) się nazywa

Bo nieskromnie powiem że ta dokumentacja którą zrobiłem na v2.t-regx.com jest duużo lepsza, nie chcę z niej rezygnować.

Po prostu mam okazję wyrenderować z niej drugą wersję, alternatywę w readthedocs i się zastanawiam czy to ma sens czy nie.

Renderuj, mi RTD się podoba. Chociaż musiałbym porównać jeszcze twoją customiwą dokumentację

KamilAdam napisał(a):

Renderuj, mi RTD się podoba. Chociaż musiałbym porównać jeszcze twoją customiwą dokumentację

Jeszcze nie jest publiczna, próbuje ją przystosować pod darkmode ale mam problem z dobraniem odpowiednich kolorów :/ To właściwie ostatni element jaki został.

Białą mam wrażenie zaprojekowałem super na wypasie, ale jak dodałem darkmode to wydaje się jakaś taka tania/biedna/amatorska.