Chyby v dokumentaci – Presenters

hrach
Člen | 1838
+
+4
-

Protoze na dlouhodobe narazky na dokumentaci vidam jen odpovedi „rekni co“, tak uz musim to sepsat sam, aniz bych Nette nejak pouzival ted vic. (Btw, odpoved „rekni co“ mi prijde relativne levna, jakoby to tazatel nezkusil analyzovat sam, co je spatne.) Z myho pohledu obecne dokumentace ma nevyhovujici strukturu, cleneni v ramci jenodtlivych pages a casto i obsah.

A ted konkretne, co si tady za par (desitek) minut jsem schopen vyhodnotit. Budu resit pouze jednu stranku, na kterou vede odkaz z rozcestniku dokumentace: Presentery

  • oteviram presentery, ctu najednou MVC; kdo uz zna architekturu a jde resit neco k presenterum, je zaplaven zbytecnosti; kdo jde hledat popis MVC, nenajde, protoze ceka Presentery, tedy cast architektury. A neceka, ze tam bude odstavec o Modelu a View.
  • kdyz prelouskam architekturu, vidim adresarovou strukturu. Ale to cloveka, ktery jde resit presentery, nebo se seznamit s MVC nezajima; rozhodne ne takto detailni a na zacatku; Pri seznami s MVC potrebuji videt, kde je index a pak M, V, C, nepotreubji videt logiku nacitani templates, etc; Tu naopak potrebuji videt, kdyz resim presenter, respektive Template, coz by melo byt v samotne kapitole. Uz vubec ani u MVC ani u Presenteru nepotrebuji videt stukturu vendoru.
  • Jeste clovek neumi zakladni praci s presenterem, ale uz se uci moduly
  • Jeste clovek neumi odeslat odpoved s presenteru, ale uci se vytvaret odkazy; IMO to ma byt v jine kapitole;
  • Ukazky jak pouzivat v salbone ifCurrent bude v Presenters hledat jen znalec, ktery bude vedet, ze to ma neco spolecneho s presenterem;
  • Vypis promennych dostupnych v sablone v presenteru je opravdu zbytecny; uz se v nem pise o flash messages, aby nekdo tusil, co to je; uz se v nem pise k komponentach, ale to jeste taky nikdo netusi, co to je;
  • Kapitola o komponentach by zaslouzila vyclenit zvlast, zminku s componente mi prijde nepatricna, protoze zde se bavime o jinych komponenatch a vnasi to tak bohuzel do systemu jeste hlubsi zmateni.
  • Jeste nejaky obsahovy chyby: flash messages nemaji zminku/context, ze jsou component bound, ne presenter bound; Prvni example pripojeni komponenty je prakticky nepouzivany, je skoda, ze je to prvni, na co clovek vidi/na co naskroluje – to muze byt v nejakym advanced; macro ifCurrent je deprecated;

K samotny strance by toho slo rict jest dal a dal, ale obecne se to da shrnout jako

  • nerozdeleny M/V/C kapitoly
  • nerozdeleny MVC vs jednotlive M/V/C kapitoly
  • nerozdeleny odkazovani a routovani, respektive jedno ma kapitolu, druhy je v Presenters
  • nevhodne razeni v ramci kapitoly

cc @Felix

Felix
Nette Core | 1245
+
+5
-

Diky moc za detailni popis. Tohle chce vetsi zasah, skoro az celou stranku predelat. Neni to jen doplnit semhle neco nebo upravit tady neco, ale jsem za to rad. Pokusim se to nejak preformulovat.

kiCkZ
Člen | 153
+
+1
-

Už jsem nahlašoval i chybu u SimpleRouter parametru a taky ani po týdnu nic, tak jsem dal PR a zatím žádné schválení, evidentně je vidět, že jak je napsáno v tom textu u podpory Nette:

Pokud bude tento cíl splněn, budeme mít rozpočet na vylepšování webu, dokumentace, můžeme tvořit obsah (články, videa), ze kterého bude mít prospěch celá komunita. A budeme moci jej nechat překládat do angličtiny.

Tak to teda moc nefunguje.

MajklNajt
Člen | 498
+
-3
-

@kiCkZ len pre info, k splneniu toho cieľu chýba cca 30k Kč

chemix
Nette Core | 1310
+
0
-

@Felix co takhle jako prvni krok rozdelit moduly do separatniho souboru a vyclenit MVC aplikaci do samostatneho souboru? co ty na to?

Gavrilo
Člen | 46
+
0
-

@MajklNajt to čo je na stránke neodpovedá realite :D David to len neaktualizuje