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:
No elimine parte de la documentación si es válida.
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.
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.
Verifique sus cambios realizando las acciones descritas mientras sigue las documentaciones.
Envíe relaciones públicas con cambios en pequeños fragmentos para que sea más fácil y rápido revisarlos y fusionarlos.
Si quieres reescribir y cambiar la estructura de un artículo grande, hazlo en dos pasos:
Reescritura
Una vez revisada, pulida y fusionada la reescritura, cambie la estructura de los párrafos en otro PR.
Construir la documentación localmente¶
La documentación también se puede editar y generar localmente; los requisitos de Python se encuentran en el grupo de dependencias docs del archivo pyproject.toml. Si ya utiliza el entorno de desarrollo completo, basta con uv sync --all-extras --dev. Para trabajar únicamente en la documentación, basta con uv sync --group docs.
El flujo de trabajo local recomendado es:
make -C docs update-docs
./ci/run-docs
El programa auxiliar ci/run-docs genera la documentación tratando las advertencias como errores.
Consejo
Además necesitará tener instalada graphviz para crear la documentación.
Traducir la documentación¶
Puedes traducir los documentos en.
Actualizando los fragmentos de documentación generados¶
Varias secciones de la documentación utilizan plantillas generadas a partir del código. La forma preferida de recargarlos es:
make -C docs update-docs
Este destino regenera los fragmentos que utiliza actualmente la documentación, entre los que se incluyen:
eventos adicionales, complementos integrados y parámetros comunes de complementos
servicios de traducción por máquinas
tablas de parámetros y características del formato de archivo
permisos y roles integrados
comprobaciones e indicadores de comprobación
Mantenga el texto actualizado manualmente en la página de documentación principal en lugar de agregarlo a fragmentos generados automáticamente. Por ejemplo, Complementos incluye tres archivos generados para eventos, complementos integrados y parámetros comunes de complementos, mientras que los complementos obsoletos se mantienen directamente en la página.
Si necesita regenerar solo una parte, los comandos de administración individuales están documentados en Órdenes de gestión, y los comandos exactos utilizados por update-docs se enumeran en docs/Makefile.