Operação

Nesta fase, "Operação" cobre a operação da documentação (Docs-as-Code). Runbooks operacionais de runtime dos serviços virão em fase posterior [TODO].

Como operar a documentação

O portal é um projeto Docusaurus versionado em Git. O fluxo é o mesmo de código: editar em branch → Pull Request → revisão → build verde → publicação [FATO — estrutura do repo].

Como atualizar o finway.json

• O finway.json é a fonte única do contrato da API [FATO — DOCS-ADR-002].
• Ele deve ser atualizado a partir do fluxo do serviço de origem (não editar à mão só para a doc) [INFERÊNCIA — prática-alvo].
• A spec fica em static/finway.json e é servida em /finway.json. A API Reference é renderizada em runtime pelo Scalar a partir dela — não há etapa de geração: basta substituir o arquivo e rodar o build [FATO — DOCS-ADR-002].
• Após atualizar, valide com npm run validate:openapi (Spectral).

Como atualizar as jornadas

• As jornadas ficam em docs/jornadas/ e são escritas/revisadas à mão [FATO].
• Ao adicionar uma jornada, incluí-la em sidebars.ts (seção jornadas) e cruzar links com a API Reference.

Como revisar mudanças

• Toda alteração entra por Pull Request com revisão [INFERÊNCIA — prática-alvo / DOCS-ADR-001].
• O build (abaixo) deve passar antes do merge.

Como validar o build

npm run build       # build de produção; falha em erros, lista links quebrados
npm run serve       # serve o build localmente para inspeção
# ou, em desenvolvimento:
npm start

A validar

• [TODO] Runbooks operacionais por serviço (usar o template de runbook em templates/ na raiz do repositório).
• [TODO] Pipeline CI/CD de publicação (Fase 6).
• [TODO] Política de versionamento da documentação.