Colaborar con la documentación de Weblate

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.

Pautas de documentación

Por favor, respete estas pautas al escribir:

  1. No elimine parte de la documentación si es válida.

  2. Usa un lenguaje claro y fácil de entender. Estás escribiendo documentos técnicos, no un poema. No todos los lectores de documentos son hablantes nativos, así que sé reflexivo.

  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. Verifique sus cambios realizando las acciones descritas mientras sigue las documentaciones.

  5. Envíe relaciones públicas con cambios en pequeños fragmentos para que sea más fácil y rápido revisarlos y fusionarlos.

  6. Si quieres reescribir y cambiar la estructura de un artículo grande, hazlo en dos pasos:

    1. Reescritura

    2. Una vez revisada, pulida y fusionada la reescritura, cambie la estructura de los párrafos en otro PR.

Construir la documentación localmente

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.

Consejo

Además necesitará tener instalada graphviz para crear la documentación.

Traducir la documentación

Puedes traducir los documentos en.

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, Complementos 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 Órdenes de gestión, and the exact commands used by update-docs are listed in docs/Makefile.