Přidat do dokumentace levý panel?

David Grudl

Klikni pro zvětšení:

Dokumentace funguje dobře i bez něj, tak nevím, jestli to není zbytečný šum. (současná podoba)

Tomáš Votruba

Osobně jsem pro 0 panelů a výstižný obsah.

Je pak těžké se soustředit a správně si vybrat, když je tam tolik možností. Tím spíš když je tam někdo poprvé.

Co by to mělo přinést?

David Grudl

Je to celkem obvyklý prvek v dokumentacích, který by měl sloužit ke snažší navigaci mezi stránkami. Ale nemám v praxi nijak ověřené, jestli je fakt užitečný, nebo naopak zbytečný.

David Grudl

Ještě mě napadlo něco takového:

Zuben45

Obě možnosti se mi líbí, ale přiklonil bych se spíše k té druhé, popřípadě k tlačítku, které by zobrazilo/skrylo levý panel :)

Milo

Ty jsi teď nasadil obdobu té druhé varianty? Nesedí mi na tom, že se nadpis těch souvisejích kapitol v pravém panelu mění podle tématu. Spíš by mi vyhovovalo něco statického, třeba „Související“. Aby když kouknu do pravého panelu, vždycky jsem našel tu samou položku.

Ale ještě zpět k první variantě s levým menu. Ta by mi asi vyhovovala víc. Nikdy jsem se nenaučil mít okno s dokumentací, a browserem obecně, zmenšené třeba na 1/2 monitoru, takže ho mám maximalizované vždy. Já mám tedy vlevo vždycky místa dost. Dokumentaci už moc nečtu, ale občas, když do ní zabloudím, je to během práce. Najít nějaký detail k formulářům, pak k DI a takhle skáču. A teď to je na X kliků. Jeden klik z levého menu by byl pro mě super.

David Grudl

Jo, zkouším s tím experimentovat a přidal jsem nahoru do pravého panelu odkaz na další kapitoly tématu.

S tím levým panelem mám jeden docela problém. Jde o otázku, zda Nette dokumentovat jako monolit, nebo jako jednotlivé balíky (cca). V případě monolitu je společné menu asi ok, v případě balíků by tam být nemělo, protože věci jako Latte, Tester, Tracy jsou zcela nezávislé a měly by se jim věnovat samostatné stránky.

Milo

Za mě určitě dokumentovat jako samostatné balíky a tím myslím obsahově. Ale levé menu bych chápal jako rozcestník, tam by mi sloučení vůbec nevadilo. Ušetří to klikání.

Spectator

Levé menu je podle mne dobré, ale asi by mi přišlo lepší, kdyby byly kapitoly sbalené a byly rozbalovací. Takhle je to dlouhé až kamsi a tím, že není vždy část vidět, se stává zakrytá část nepoužitelná.

Pavel Janda

První varianta naprosto boží!!

Lidé, kteří si prochází dokumentaci, se rádi rychle prokliknou na související kapitoly. Klidně se tam dá zmínit, že jde o jiné balíky. Třeba jinou barvou apod.

Editoval Pavel Janda (4. 9. 2017 11:51)

Felix

Zajimavy napad je zobrazit/skryt ten levy panel z 1. prikladu. Kdyz by to nekoho obtezovalo, tak by si to mohl pohodlne skryt. Levy navigacni panel je super vec, usetri radu prokliku. Jedina nevyhoda je, jak uz jsi zminoval, ze by to mohlo nekoho plest, ze se jednotlive balicky nedaji pouzivat zvlast. Bohuzel me nenapada jak to elegantne vyresit.

Dobra prace mimochodem ;-)

pekelnik

Navigace mi v dokumentaci vždycky chyběla :)

dez1nd

David Grudl napsal(a):

Klikni pro zvětšení:

Dokumentace funguje dobře i bez něj, tak nevím, jestli to není zbytečný šum. (současná podoba)

Jsem pro obě. :)

karelu

David Grudl napsal(a):

Klikni pro zvětšení:

Dokumentace funguje dobře i bez něj, tak nevím, jestli to není zbytečný šum. (současná podoba)

Davide,
ta navigace vlevo je naprosto super, jen bych nenechával v tom levém sloupci nahoře tolik místa.

Díky

Karel

igor.pocta

Ahoj,

nějak postrádám odkaz do Download ( https://nette.org/cs/packages , tady v modré hlavičce je).

Přes prvotní tutoriál jsem se dostal sem – https://doc.nette.org/cs/quickstart – kde jsem už našel příkaz pro composer .

Václav Pávek

jsem pro variantu 1