Como Documentar?

Nesta página você irá encontrar como documentar dentro do nosso projeto.

Tutorial

Observação: Para documentar você precisa ter conhecimento sobre o Markdown.

Primeiro baixe o repositório seguindo os passos do tópico Desenvolvedor > Utils > Windows dentro da nossa documentação. Após isso acesse a pasta docs > docs dentro do projeto. Dentro desta pasta há as abas de introdução, usuário e desenvolvedor. Entre dentro da que deseja criar um novo conteúdo, adicione uma pasta para representar o seu tópico e crie os arquivos .md. Agora use sua imaginação para descrever da melhor forma possível o que deseja e sempre siga os padrões que já foram implementados nos outros arquivos de documentação.

Para visualizar a documentação em sua versão web, rode o comando:

$ pnpm run docs