Melhore este manual¶
O manual está escrito em Markdown no diretório docs/ e é gerado com o MkDocs.
Visualização local¶
Crie um ambiente virtual e instale as dependências da documentação:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Abra o endereço local impresso pelo MkDocs. A visualização é reconstruída quando um ficheiro de origem é alterado.
Valide o site¶
Antes de abrir um pull request:
A construção estrita reporta entradas de navegação em falta, links inválidos detetados por MkDocs e avisos de configuração.
Princípios de escrita¶
- Escreva para uma tarefa e um público específicos.
- Indique a versão MRBS quando o comportamento é específico da versão.
- Prefira exemplos testados a listas exaustivas.
- Nunca inclua credenciais reais ou dados de reservas privadas.
- Ligue tarefas relacionadas em vez de duplicar secções grandes.
- Atualize todas as traduções disponíveis quando for prático.
Traduções¶
O inglês é o texto de referência. As páginas em alemão, francês e espanhol utilizam o mesmo caminho relativo com um sufixo de localidade:
Quando falta uma tradução, o site volta para inglês. Uma tradução deve preservar o código, definir nomes, avisos e ligações enquanto utiliza terminologia natural na língua de chegada.
Âmbito¶
Esta árvore de documentação tem como alvo MRBS 1.12.2. As alterações que descrevem uma versão posterior devem atualizar o âmbito da versão visível ou ser desenvolvidas na documentação definida para essa versão.