Pular para conteúdo

Wiki Docs

Documentacao curada e versionada para:

  1. consulta direta no repositorio;
  2. publicacao na Wiki do GitHub;
  3. publicacao no portal MkDocs.

Fonte de verdade

O conteudo curado fica em docs/wiki/.

  • .context/ continua sendo a trilha operacional e de governanca.
  • docs/wiki/ concentra o que deve ser lido por stakeholders, produto, arquitetura e onboarding.
  • MkDocs e GitHub Wiki refletem a mesma base, sem duplicar texto em outra arvore.

MVP 1

  • MVP-1-Visao-Geral.md
  • MVP-1-Arquitetura-Geral.md
  • MVP-1-Autenticacao-Negocio.md
  • MVP-1-Autenticacao-Tecnico.md
  • MVP-1-Transacoes-Negocio.md
  • MVP-1-Transacoes-Tecnico.md
  • MVP-1-Dashboard-Negocio.md
  • MVP-1-Dashboard-Tecnico.md
  • MVP-1-Metas-Negocio.md
  • MVP-1-Metas-Tecnico.md
  • MVP-1-Carteira-Negocio.md
  • MVP-1-Carteira-Tecnico.md
  • MVP-1-Ferramentas-Publicas.md

MVP 2

  • MVP-2-Empresas.md

Plataforma

  • Plataforma-Superficies-Publicas.md
  • graphql/index.html
  • graphql/overview.md
  • Plataforma-Scripts.md
  • Plataforma-Scripts-Matriz-de-Uso.md
  • Plataforma-Auditoria-Final-de-Docs.md

API

  • api/index.html
  • graphql/index.html
  • graphql/overview.md

Operacao local

  1. make docs-setup
  2. make docs-build
  3. make docs-serve
  4. make docs-sync-wiki