Közreműködés a Weblate dokumentációban¶
Szívesen látjuk, ha bármelyik dokumentációs oldalt javítja vagy bővíti. Ezt legegyszerűbben a jobb felső sarokban található Oldal szerkesztése gombra kattintva teheti meg.
Dokumentációs irányelvek¶
Az alábbi elveket tartsa szem előtt írás közben:
Ne töröljön olyan részt a dokumentációból, amely még érvényes.
Használjon világos, könnyen érthető nyelvezetet. Ez technikai dokumentáció – nem vers. Ne feledje, hogy nem minden olvasó anyanyelve az angol.
Ha valamiben nem biztos, bátran kérdezzen. Ha szerkesztés közben kérdése merül fel egy funkcióval kapcsolatban, ne módosítsa annak leírását, amíg nem kapott választ. Vagy módosítson vagy kérdezzen – a kettőt egyszerre ne tegye.
Ellenőrizze a módosításait úgy, hogy végrehajtja az útmutatóban szereplő lépéseket.
A módosításokat kis, áttekinthető részekre bontva küldje be, hogy az ellenőrzés és az összevonás gyorsabb és egyszerűbb legyen.
Ha egy nagyobb cikket szeretne újrafogalmazni és átszerkeszteni, tegye ezt két lépésben:
Először végezze el az újrafogalmazást
Miután az átírás ellenőrzésre és elfogadásra került, külön PR-ben (módosítási kérelemben) módosítsa a bekezdések szerkezetét.
A dokumentáció helyi szerkesztése és fordítása¶
Documentation can be also edited and built locally, the Python requirements are
in the docs dependency group in pyproject.toml. If you already use
the full development environment, uv sync --all-extras --dev is enough. For
documentation work only, uv sync --group docs is sufficient.
The recommended local workflow is:
make -C docs update-docs
./ci/run-docs
The ci/run-docs wrapper builds the documentation with warnings treated as errors.
Tipp
A dokumentáció építéséhez szükséges a graphviz telepítése is.
A dokumentáció fordítása¶
A dokumentáció fordítása elérhető itt: translate the docs.
Updating generated documentation snippets¶
Several documentation sections use templates generated from the code. The preferred way to refresh them is:
make -C docs update-docs
This target regenerates the snippets currently used by the documentation, including:
add-on events, built-in add-ons, and common add-on parameters
machine translation services
file format parameters and file format feature tables
permissions and built-in roles
checks and check flags
Keep manually maintained text in the parent documentation page rather than adding it to autogenerated snippets. For example, Kiegészítők includes three generated files for events, built-in add-ons, and common add-on parameters, while obsolete add-ons are maintained directly in the page.
If you need to regenerate only one part, the individual management commands are
documented in Kezelőparancsok, and the exact commands used by
update-docs are listed in docs/Makefile.