Diskuze: GitHub dokumentace

Honza Bittner

Tvůrce

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

FIT ČVUT alumnus :-) Sleduj mě na https://twitter.com/tenhobi a ptej se na cokoli na https://github.com/tenhobi/ama.

Martin Dráb

Tvůrce

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

Adam Ježek

Tvůrce

Adam Ježek:30.12.2015 1:18

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

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

Počkej chvíli, poradím se s křišťálovou koulí.

Jaro

Člen

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

30.12.2015 8:57

“What would you do if you were 100% sure you couldn’t fail?”

Naučíme tě pracovat na home-office.

Více info »

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.