Ir para o conteúdo

Vanguru — Documentação Interna

Bem-vindo. Esta é a documentação técnica e operacional da Vanguru, plataforma SaaS de gestão de transporte escolar.

Acesso

Você só está vendo esta página porque está autenticado via Cloudflare Access (Google Workspace ou GitHub team).

Onde começar

Você é... Comece em
Dev novo no time Onboarding dev
Founder / produto Onboarding founder
Agente LLM (Claude, Gemini) Onboarding AI agent

Áreas

Técnica

  • Arquitetura — Visão geral, GCP topology, Firestore, DAQ
  • Segurança — LGPD, threat models, padrões PII
  • API — Functions, Payments, API Gateway
  • Guias — Setup local, Flutter, Java, Firebase, AI/LLMs

Operacional

  • Runbooks — Deploy, incident response, DSAR, rotate secrets
  • Operations — Data retention, observability, Play Store publishing

Por projeto

  • Projetos — Documentação por subsistema (vanguru_mobile, payments-api, etc.)

Negócio

  • Business — Pricing, plano de negócios, análise de custos
  • Strategy — Decisões estratégicas, premium evolution
  • Product — Features, personas
  • Business rules — Regras operacionais

Iniciativas

  • Initiatives — Iniciativas com ADRs embutidos em cada 04-decisoes-arquiteturais.md

Status da migração

Conteúdo está sendo migrado em fases:

Fase O que migra Status
F5 development/ + business/ em andamento
F6 READMEs do vanguru_mobile/ pendente
F7 docs/ local (iniciativas) pendente
F9 Arquivamento dos repos legados pendente

Ver docs-architecture/05-plano-de-migracao (após F7) para o plano completo.

Como contribuir

  1. Clone o repo internal-docs localmente.
  2. Edite ou crie markdown em docs/<area>/.
  3. Use frontmatter padrão (ver README do repo).
  4. Abra PR — validate.yml checa mkdocs build --strict.
  5. Após approval, merge → site rebuilda em ~2 min.

Como acessar via LLM

Decisão F0 §Q-05: clone local.

cd ~/project/vanguru
git clone https://github.com/rotaescolarappbr/internal-docs

Aponta o agente (Claude Code, Gemini, etc.) para ~/project/vanguru/internal-docs/docs/ quando trabalhar em outros repos. Ver onboarding/ai-agent para detalhes.