Imobiliária Bortone — Documentação
Bem-vindo à documentação do projeto. Utilize o menu para navegar pelos guias e padrões.
Projeto acadêmico desenvolvido pelas turmas da FATEC Registro para o Laboratório de Práticas 2025-2.
O que você encontra aqui
- Visão geral de configuração do Next.js.
- Manual de tags e convenções de código.
- Regras gerais do repositório (branches, commits, PRs, revisão).
- Detalhes do algoritmo de recomendação.
- API de Mapa - Documentação completa das rotas e funcionalidades de mapa.
Como rodar a documentação localmente
- Instale dependências do MkDocs (Material):
pip install mkdocs mkdocs-material
- Na pasta
documentacao/
, execute: mkdocs serve
- Acesse
http://127.0.0.1:8000
.
Estrutura dos documentos
- Arquivos Markdown ficam em
documentacao/docs/
. - Recursos estáticos (imagens, ícones) em
documentacao/docs/assets/
. - Navegação configurada em
documentacao/mkdocs.yml
.
Se notar algo desatualizado, abra uma issue ou PR seguindo as regras gerais.