Contribuiți la documentația Weblate

Sunteți binevenit să îmbunătățiți pagina de documentație pe care o alegeți. Faceți-o cu ușurință făcând clic pe butonul Edit on GitHub din colțul din dreapta sus al paginii.

Documentation guidelines

Vă rugăm să respectați aceste orientări atunci când scrieți:

  1. Nu eliminați o parte din documentație dacă aceasta este valabilă.

  2. Folosiți un limbaj clar și ușor de înțeles. Scrieți documente tehnice, nu o poezie. Nu toți cititorii de documente sunt vorbitori nativi, fiți atent.

  3. Nu vă fie teamă să întrebați dacă nu sunteți sigur. Dacă trebuie să întrebați despre o anumită caracteristică în timpul editării, nu modificați documentele înainte de a avea răspunsul. Aceasta înseamnă că: Modificați sau întrebați. Nu le faceți pe amândouă în același timp.

  4. Verificați modificările efectuate prin efectuarea acțiunilor descrise în timp ce urmați documentația.

  5. Trimiteți PR cu modificări în bucăți mici pentru a facilita și accelera revizuirea și fuzionarea.

  6. Dacă doriți să rescrieți și să schimbați structura unui articol mare, faceți-o în doi pași:

    1. Rescrieți

    2. După ce rescrierea este revizuită, șlefuită și îmbinată, modificați structura paragrafelor într-un alt PR.

Building the documentation locally

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. The build can be performed using ci/run-docs.

Sugestie

You will also need graphviz installed to build the documentation.

Translating the documentation

Puteți traduce documentația.

Documenting permissions, checks, add-ons and automatic suggestions

Several documentation sections use templates generated from the code. The following management commands are available:

All these commands output reStructuredText which is used as a template for the documentation. The easiest way to apply changes to the documentation is using visual diff in your editor.