Contribute to Weblate documentation

Puedes mejorar la página de documentación que prefieras. Hazlo fácilmente haciendo clic en el botón Editar en GitHub en la esquina superior derecha de la página.

Documentation guidelines

Please respect these guidelines while writing:

  1. Don’t remove part of the documentation if it’s valid.

  2. Use clear and easily-understandable language. You are writing tech docs, not a poem. Not all docs readers are native speakers, be thoughtful.

  3. No tengas miedo de preguntar si no estás seguro. Si tienes que preguntar sobre alguna característica mientras estás editando, no cambies la documentación antes de tener la respuesta. Esto significa: cambias o preguntas. No hagas ambas cosas al mismo tiempo.

  4. Verify your changes by performing described actions while following the docs.

  5. Send PR with changes in small chunks to make it easier and quicker to review and merge.

  6. If you want to rewrite and change the structure of a big article, do it in two steps:

    1. Rewrite

    2. Once the rewrite is reviewed, polished, and merged, change the structure of the paragraphs in another 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.

Consejo

You will also need graphviz installed to build the documentation.

Translating the documentation

You can translate the docs.

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.