Ir para o conteúdo

docs/ — Documentação operacional

Guias para implantação, operação e troubleshooting do Lorentz VPS Stack. Publicados como site MkDocs para a equipe de suporte.

Comece aqui

Documento Conteúdo
28-indice-instalacao-apps.md Índice instalação — todos os apps
33-checklist-teste-ambiente.md Checklist teste + pendências (Alta/Média/Baixa)
SUPORTE-COMECE-AQUI.md Landing mastigada para suporte
00-indice.md Índice completo + scripts
MAPA-FLUXO-AMBIENTE.md Arquitetura, portas, deploy em uma página
instalacao-suporte.md Instalação completa (include)

Site MkDocs

pip install -r requirements-docs.txt
./scripts/serve-docs.sh    # http://127.0.0.1:8000
./scripts/build-docs.sh    # pasta site/

Configuração: mkdocs.yml na raiz do repo — ver 26-documentacao-web-mkdocs.md.

Mapa de pastas do repositório {#mapa-de-pastas}

Cada pasta principal do stack tem seu próprio README.md (no filesystem do Git, não neste site):

Pasta Arquivo
Raiz README.md
config/ config/README.md
docker/ docker/README.md
portal/ portal/README.md
scripts/ scripts/README.md
themes/ themes/README.md
resources/ resources/README.md
dist/ dist/README.md

Documentos numerados (01–26)

Sequência recomendada em 00-indice.md. Destaques:

  • Deploy: 13, 25, INSTALACAO-SUPORTE
  • Apps: 17–20 (Monitor, Webphone, Portal)
  • Roadmap: 21–23 (Impacta, domínio, licença)
  • Lab: 24

Externo (monorepo)

Pasta externo/README.md — includes de docs em ../server/.

Relacionado

  • CHANGELOG.md na raiz do repo
  • README.md na raiz — visão geral do stack