Bidra till Weblate-dokumentationen¶
Du är välkommen att förbättra den dokumentationssida du önskar. Det gör du enkelt genom att klicka på knappen Redigera på GitHub i det övre högra hörnet av sidan.
Riktlinjer för dokumentation¶
Vänligen respektera dessa riktlinjer när du skriver:
Ta inte bort delar av dokumentationen om den är giltig.
Använd ett tydligt och lättförståeligt språk. Du skriver tekniska dokument, inte en dikt. Alla som läser dokumenten är inte modersmålstalare, så var uppmärksam på detta.
Var inte rädd att fråga om du är osäker. Om du behöver fråga om någon funktion medan du redigerar, ändra inte dokumentationen innan du har fått svar. Det betyder: Ändra eller fråga. Gör inte båda samtidigt.
Verifiera dina ändringar genom att utföra beskrivna åtgärder enligt dokumentationen.
Skicka PR med ändringar i små delar för att göra det enklare och snabbare att granska och sammanfoga.
Om du vill skriva om och ändra strukturen på en lång artikel, gör det i två steg:
Skriv om
När omskrivningen har granskats, finslipats och sammanfogats, ändra strukturen på styckena i en annan PR.
Bygga dokumentationen lokalt¶
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.
Råd
Du behöver också graphviz installerat för att kunna skapa dokumentationen.
Översättning av dokumentationen¶
Du kan översätta dokumenten.
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, Tillägg 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 Ledningskommandon, and the exact commands used by
update-docs are listed in docs/Makefile.