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

Sugestie

You will also need graphviz installed to build the documentation.

Translating the documentation

Puteți traduce documentația.

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, Suplimente 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 Comenzi de gestionare, and the exact commands used by update-docs are listed in docs/Makefile.