Contribute to the documentation

Found a gap?

The documentation follows the evolution of Lyra OS. A confusing step, a different message in your version or a missing topic are good opportunities to contribute.

Open the website repository and use the issues area to propose a correction. Include the page, the passage, the Lyra version you used and the result you observed. For system defects, use the repositories listed in the troubleshooting guide.

Propose a change

1. Fork the website repository on GitHub and create a branch for the change.
2. Edit the article content in docs/content/. The catalog.json file organizes titles, descriptions and categories.
3. Run python3 scripts/build-docs.py at the project root to generate the pages and the search index.
4. Check the navigation, the instructions and the layout on a small screen.
5. Open a pull request with the correction and explain which version you checked the procedure on.

Write for the people who will use the system

• Start with the goal and the requirements of the procedure.
• Explain what commands do before asking people to run them.
• Highlight operations that erase data or change storage.
• Keep released features separate from plans and features in development.
• Include a reference to the release notes or to the component's documentation.

Translate and update translations

Portuguese is the source language of the guides. The English, Spanish and Italian versions live in docs/content/en/, docs/content/es/ and docs/content/it/, each with its own catalog.json.

• Keep the same file name, the same h2 heading IDs and the commands unchanged.
• When revising a guide in Portuguese, also update the translations or leave them flagged as outdated.
• In the translation catalog, source_reviewed records the review date of the Portuguese original used as the basis. When the original is newer, the translated page shows a notice linking to the Portuguese version.