Contribuye

Contribuir a la documentación

Sugiere correcciones, comunica dudas y ayuda a mejorar las guías para otras personas.

ProcedimientoDocumentación del sitioRevisión documental: Traducido de la versión en portugués revisada el

¿Encontraste un vacío?

La documentación acompaña la evolución de Lyra OS. Un paso confuso, un mensaje distinto en tu versión o un tema que falta son buenas oportunidades para contribuir.

Abre el repositorio del sitio y usa el área de issues para proponer una corrección. Indica la página, el fragmento, la versión de Lyra usada y el resultado que observaste. Para defectos del sistema, usa los repositorios indicados en la guía de diagnóstico.

Propón un cambio

  1. Crea una copia (fork) del repositorio del sitio en GitHub y una rama para el cambio.
  2. Edita el contenido del artículo en docs/content/. El archivo catalog.json organiza títulos, descripciones y categorías.
  3. Ejecuta python3 scripts/build-docs.py en la raíz del proyecto para generar las páginas y el índice de búsqueda.
  4. Revisa la navegación, las instrucciones y la presentación en una pantalla pequeña.
  5. Abre un pull request con la corrección y explica en qué versión comprobaste el procedimiento.

Escribe para quien va a usar el sistema

  • Empieza por el objetivo y los requisitos del procedimiento.
  • Explica el efecto de los comandos antes de pedir que se ejecuten.
  • Destaca las operaciones que borran datos o modifican el almacenamiento.
  • Separa las funciones publicadas de los planes y funciones en desarrollo.
  • Incluye una referencia a las notas de lanzamiento o a la documentación del componente.

Traduce y actualiza las traducciones

El portugués es el idioma de origen de las guías. Las versiones en inglés, español e italiano están en docs/content/en/, docs/content/es/ y docs/content/it/, cada una con su propio catalog.json.

  • Mantén el mismo nombre de archivo, los mismos ID de los títulos h2 y los comandos sin cambios.
  • Al revisar una guía en portugués, actualiza también las traducciones o déjalas marcadas como desactualizadas.
  • En el catálogo de la traducción, source_reviewed registra la fecha de revisión del original en portugués usado como base. Cuando el original es más reciente, la página traducida muestra un aviso con un enlace a la versión en portugués.