Diskuze: GitHub dokumentace

Volná diskuze GitHub dokumentace

Aktivity (1)
Avatar
Honza Bittner
Redaktor
Avatar
Honza Bittner:29.12.2015 23:24

Jak tvoříte dokumentaci na GitHubu? Ukládáte ji např. v podobě markdown souborů do nějaké složky doc/ nebo docs/, nebo využíváte wiki stránku/záložku?

Proč používáte právě tu či onu možnost?

Prosím hlasujte na https://twitter.com/…528097480705.

Odpovědět 29.12.2015 23:24
Student FIT ČVUT. Followuj mě na https://twitter.com/tenhobi a ptej se na https://github.com/HoBi/ama.
Avatar
Martin Dráb
Redaktor
Avatar
Odpovídá na Honza Bittner
Martin Dráb:30.12.2015 1:15

Já se snažím ukládat všechnu dokumentaci do doc (jak mi to ve skutečnosti jde, je věc jiná...), protože je pro uživatele jednodušší si ji vzít než asi tu Wiki.

EDIT
Hlasovat nebudu, nemám na Twitteru účet, tak jsem ani na ten link nelezl.

Editováno 30.12.2015 1:16
Nahoru Odpovědět 30.12.2015 1:15
2 + 2 = 5 for extremely large values of 2
Avatar
Adam Ježek
Tým ITnetwork
Avatar
Adam Ježek:30.12.2015 1:18

Jak tvořím dokumentaci? Většinou nijak. Promiň, ale já si to prostě nemoh odpustit. :D

Občas se tam objeví .txt s pár kecama a že většina je v komentářích u kódu, nebo to napíšu ve Wordu a je tam doc(x)

Nahoru Odpovědět 30.12.2015 1:18
Pokud chceš odpovědět, klikni na odpovědět. Pokud chceš vložit zdroják, klikni na vložit zdroják (</>)
Avatar
Jaro
Člen
Avatar
Odpovídá na Honza Bittner
Jaro:30.12.2015 8:57

Popis aplikácie, ako to nainštalovať, pripadne ako to používať je väčšinou v markdown. Dokumentácia ku kódu je kód samotný (ideálne aj s testami).

Nahoru Odpovědět  +1 30.12.2015 8:57
A ship is safe in harbor. But then again, that´s not what ships are for.
Děláme co je v našich silách, aby byly zdejší diskuze co nejkvalitnější. Proto do nich také mohou přispívat pouze registrovaní členové. Pro zapojení do diskuze se přihlas. Pokud ještě nemáš účet, zaregistruj se, je to zdarma.

Zobrazeno 4 zpráv z 4.