Contribuir com a documentação

Encontrou uma lacuna?

A documentação acompanha a evolução do Lyra OS. Uma etapa confusa, uma mensagem diferente na sua versão ou um assunto que falta são boas oportunidades de contribuição.

Abra o repositório do site e use a área de issues para propor uma correção. Informe a página, o trecho, a versão do Lyra usada e o resultado que você observou. Para defeitos do sistema, use os repositórios indicados no guia de diagnóstico.

Proponha uma alteração

1. Crie uma cópia do repositório do site no GitHub e uma branch para a mudança.
2. Edite o conteúdo do artigo em docs/content/. O arquivo catalog.json organiza títulos, descrições e categorias.
3. Execute python3 scripts/build-docs.py na raiz do projeto para gerar as páginas e o índice de busca.
4. Confira a navegação, as instruções e a apresentação em uma tela pequena.
5. Abra um pull request com a correção e explique em qual versão você conferiu o procedimento.

Escreva para quem vai usar o sistema

• Comece pelo objetivo e pelos requisitos do procedimento.
• Explique o efeito de comandos antes de pedir que a pessoa os execute.
• Destaque operações que apagam dados ou alteram o armazenamento.
• Separe recursos publicados de planos e funcionalidades em desenvolvimento.
• Inclua uma referência às notas de lançamento ou à documentação do componente.

Traduza e atualize traduções

O português é o idioma de origem dos guias. As versões em inglês, espanhol e italiano ficam em docs/content/en/, docs/content/es/ e docs/content/it/, cada uma com o seu catalog.json.

• Mantenha o mesmo nome de arquivo, os mesmos IDs dos títulos h2 e os comandos sem alteração.
• Ao revisar um guia em português, atualize também as traduções ou deixe-as marcadas como desatualizadas.
• No catálogo da tradução, source_reviewed registra a data de revisão do original em português usado como base. Quando o original for mais recente, a página traduzida exibe um aviso com link para a versão em português.