Go doc

Go-moduljaink a kézikönyvüket és a referenciájukat is a forrásban tartják: a csomagkommentek írják le, hogyan illeszkednek a részek, a doc-kommentek pedig minden exportált azonosítót. Minden kiadási tag közzéteszi az ezekből épült HTML-t a /godoc/ alatt. Az alábbi táblázat mindig a legfrissebb kiadott verziót mutatja. A Ruby gemek ugyanezt RDoc-kal csinálják.

Kiadott modulok

Modulonként a tíz legújabb verzió marad meg; a /godoc/inkwell/latest/ mindig a legújabbra mutat, és minden oldal tetején a verzióválasztóval lehet váltani köztük.

A szabály: minden dokumentált

A modul CLAUDE.md-je kimondja, és a CI ki is kényszeríti: a push elbukik, ha a revive (az exported szabály, revive.toml a repóban) doc-komment nélküli exportált típust, függvényt, metódust, konstanst vagy változót talál.

• A komment az azonosító nevével kezdődik, és leírja, mit csinál, mit kap és mit ad vissza, milyen hibát ad és mit változtat meg. A változtatás oka a commitba megy, nem a kommentbe.
• Go doc-jelölés, nem Markdown: [Név] és [csomag.Név] linkek, # Fejléc szakaszok a csomagkommentekben, lista --vel, kód behúzott blokkban.
• Minden csomag csomagkommentje a doc.go-ban van; ott él a kézikönyv is — hogyan épül fel egy játék, példákkal. A README.md csak ide linkel.

Hogyan kerül ide

1. A kiadási tag lefuttatja a modul pipeline-ját: fordítás, vet, a dokumentációs kapu, majd a doc2go megépíti a HTML-t és egy meta.json-t (verzió, commit, dátum).
2. A pipeline feltölti a godoc.tar.gz-t Gitea generic csomagként az engines orgba, a modul nevén -godoc végződéssel.
3. A Gitea csomag-webhookja meghívja a wiki-fetchert, amely tízpercenként magától is ránéz. Kicsomagolja az új verziót, ráteszi a wiki arculatát, átállítja a latest-et és újraírja a /godoc/index.json-t.
4. A fenti táblázat a böngészőben olvassa ezt az indexet, a motoroldalak pedig a latest címre linkelnek, így kiadáskor egy wikioldalt sem kell szerkeszteni.

Ha egy kör elbukik, a wiki-fetcher /health-je piros lesz. Részletek: fetcher/README.md a services/wiki-pages-ben.