Bijdragen aan documentatie voor Weblate

U bent van harte uitgenodigd om elke door u gekozen pagina van de documentatie verbeteren. Doe dat gemakkelijk door te klikken op de knop Edit this page in de rechterbovenhoek van de pagina.

Documentatie richtlijnen

Respecteer deze richtlijnen tijdens het schrijven:

  1. Verwijder geen deel van de documentatie als dat nog geldig is.

  2. Gebruik duidelijke en gemakkelijk te begrijpen taal. U schrijft technische documenten, geen gedicht. Niet alle lezers van de documentatie zijn sprekers in de eigen taal, denk daar aan.

  3. Wees niet bang om het te vragen als u niet zeker bent van uw zaak. Als u iets na moet vragen over een bepaalde mogelijkheid tijdens het bewerken, wijzig dan de documenten ervan niet voordat u het antwoord heeft. Dit betekent: U vraagt of u wijzigt. Doe niet allebei tegelijkertijd.

  4. Verifieer uw wijzigingen door de beschreven acties uit te voeren, terwijl u de documentatie volgt.

  5. Verstuur een PR met wijzigingen in kleine delen om het gemakkelijker en sneller te kunnen beoordelen en samen te voegen.

  6. Als u opnieuw wilt schrijven en de structuur van een groot artikel wilt wijzigen, doe dat dan in twee stappen:

    1. Opnieuw schrijven

    2. Als het opnieuw geschreven deel eenmaal is beoordeeld, gepolijst en samengevoegd, wijzig dan de structuur van de alinea’s in een ander PR.

De documentatie lokaal bouwen

Documentatie kan ook lokaal worden bewerkt en gebouwd, de vereisten voor Python staan in de groep met afhankelijkheden docs in pyproject.toml. Het bouwen kan worden uitgevoerd met ci/run-docs.

Hint

U zult ook graphviz geïnstalleerd moeten hebben om de documentatie te bouwen.

De documentatie vertalen

U kunt de documentatie vertalen.

Rechten voor documenteren, controles, add-ons en automatische suggesties

Verscheidene gedeelten van de documentatie gebruiken sjablonen die worden gegenereerd uit de code. De volgende opdrachten voor beheer zijn beschikbaar:

Al deze opdrachten voeren reStructuredText uit die als sjabloon wordt gebruikt voor de documentatie. De gemakkelijkste manier om wijzigingen aan de documentatie te maken is door visuele verschillen in uw bewerker te gebruiken.