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:

  1. Ta inte bort delar av dokumentationen om den är giltig.

  2. 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.

  3. 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.

  4. Verifiera dina ändringar genom att utföra beskrivna åtgärder enligt dokumentationen.

  5. Skicka PR med ändringar i små delar för att göra det enklare och snabbare att granska och sammanfoga.

  6. Om du vill skriva om och ändra strukturen på en lång artikel, gör det i två steg:

    1. Skriv om

    2. När omskrivningen har granskats, finslipats och sammanfogats, ändra strukturen på styckena i en annan PR.

Bygga dokumentationen lokalt

Dokumentationen kan också redigeras och byggas lokalt. Python-kraven finns i beroendegruppen docs i pyproject.toml. Byggandet kan utföras med ci/run-docs.

Råd

Du behöver också graphviz installerat för att kunna skapa dokumentationen.

Översättning av dokumentationen

Du kan översätta dokumenten.

Dokumentera behörigheter, kontroller, tillägg och automatiska förslag

Flera dokumentationsavsnitt använder mallar som genereras från koden. Följande hanteringskommandon är tillgängliga:

Alla dessa kommandon genererar reStructuredText som används som mall för dokumentationen. Det enklaste sättet att tillämpa ändringar i dokumentationen är att använda visuell diff i din editor.