🌐 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ça | Função | Custo |
|---|---|---|
Quartz v5 (pasta portal/) | Transforma a pasta docs/ em site: links, busca, grafo, painéis .base | grátis, código aberto (MIT) |
| Cloudflare Pages | Publica o site a cada commit no GitHub | grátis |
| Cloudflare Access | Pede um código enviado ao e-mail; só e-mails autorizados entram | grá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.canvase.docx. - Os painéis
.basedo 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/publicRequer 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 & Pages → Create → Pages → Connect to Git → escolha o repositório.
| Campo | Valor |
|---|---|
| Nome do projeto | v360-docs |
| Production branch | main |
| Framework preset | None |
| Root directory | portal |
| Build command | git fetch --unshallow; npm ci && npx quartz plugin install --from-config && npx quartz build -d ../docs |
| Build output directory | public |
| Variável de ambiente | NODE_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/*eportal/*: mudanças só no código do app não refazem o site.
3. Cloudflare Access (privacidade)
- Cloudflare → Zero Trust (crie a organização no plano Free).
- Settings → Authentication → Login methods: ative One-time PIN.
- Access → Applications → Add an application → Self-hosted.
- Domínios:
v360-docs.pages.deve*.v360-docs.pages.dev(versões de teste). Se usar domínio próprio, inclua também. - Política Allow → Include → Emails: e-mails das sócias e o seu.
- 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.deve 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).