- Localizada na barra lateral sob "Sobre o projeto"
- Contém documentação principal do projeto
- Acessível pela barra de navegação superior ou barra lateral
Detalhamento das principais tecnologias:
- Docusaurus: Plataforma de documentação
- Next.js: Framework web
- Firebase: Serviços de backend
- React Native: Desenvolvimento mobile
Acessível via navegação lateral:
- Objetivos do projeto
- Diagramas de classe
- Requisitos funcionais/não-funcionais
- Protótipos (Figma)
Localizado em "Como contribuir com o projeto?":
- Formulários de feedback
- Instruções para testes
- Como reportar problemas
- Link para documentação
- Link para repositório GitHub
- Organização hierárquica com seções:
- Documentação
- Informações técnicas
- Diretrizes de contribuição
- Visualização de protótipos
- Formulários de feedback
- Links para download
- Recursos adicionais
- Links da comunidade
- Informações de copyright
This website is built using Docusaurus, a modern static website generator.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.