🌐 Portal de Documentação

Objetivo

As sócias leem toda a documentação num site privado, bonito e com busca, sem instalar nada.

Como funciona

PeçaFunçãoCusto
Quartz v5 (pasta portal/)Transforma a pasta docs/ em site: links, busca, grafo, painéis .basegrátis, código aberto (MIT)
Cloudflare PagesPublica o site a cada commit no GitHubgrátis
Cloudflare AccessPede um código enviado ao e-mail; só e-mails autorizados entramgrátis no plano Zero Trust Free (até 50 usuários — confirmar ao criar a conta)
  • O site lê docs/ direto: não existe cópia do conteúdo.
  • Ficam de fora: .obsidian, 90 Templates, 99 Anexos, arquivos .canvas e .docx.
  • Os painéis .base do Obsidian aparecem no site; Painéis/ traz as versões resumidas.
  • Cada página de requisito mostra no topo: status, sprint, prioridade, etapa, gate, se usa IA e autora.
  • Página inicial: docs/index.md (mostra o 00 Comece Aqui).
  • Configuração: portal/quartz.config.yaml (título, idioma, cores, o que aparece).

Usar no computador

npm run portal:install   # só na primeira vez
npm run portal:dev       # abre em http://localhost:8080 e atualiza sozinho
npm run portal:build     # gera o site em portal/public

Requer Node 22 ou mais novo.

Publicar (uma vez só)

1. GitHub

Envie o repositório v360-app para o GitHub (privado).

2. Cloudflare Pages

Cloudflare → Workers & PagesCreatePagesConnect to Git → escolha o repositório.

CampoValor
Nome do projetov360-docs
Production branchmain
Framework presetNone
Root directoryportal
Build commandgit fetch --unshallow; npm ci && npx quartz plugin install --from-config && npx quartz build -d ../docs
Build output directorypublic
Variável de ambienteNODE_VERSION = 22

Depois do primeiro deploy, o site fica em https://v360-docs.pages.dev. Se o nome for outro, ajuste baseUrl em portal/quartz.config.yaml.

Economia de builds

Em Settings → Builds → Build watch paths, inclua só docs/* e portal/*: mudanças só no código do app não refazem o site.

3. Cloudflare Access (privacidade)

  1. Cloudflare → Zero Trust (crie a organização no plano Free).
  2. Settings → Authentication → Login methods: ative One-time PIN.
  3. Access → Applications → Add an application → Self-hosted.
  4. Domínios: v360-docs.pages.dev e *.v360-docs.pages.dev (versões de teste). Se usar domínio próprio, inclua também.
  5. Política AllowIncludeEmails: e-mails das sócias e o seu.
  6. Salve e teste numa janela anônima com um e-mail autorizado e um não autorizado.

Cada endereço precisa estar protegido

O pages.dev e um domínio próprio são endereços separados. Proteja todos, senão um deles fica público.

Adicionar ou remover uma pessoa

Zero Trust → Access → Applications → v360-docs → política → editar a lista de e-mails. Registre a mudança no Registro de Mudanças.

Atualizar o Quartz

Raramente necessário. Peça a um agente: “Atualize o Quartz em portal/ para a versão estável mais recente, preservando quartz.config.yaml, e rode npm run portal:build.”

Status

pronto-local — build testado no computador em 2026-09-16 (150 páginas). Falta publicar (passos 1–3).