jhony75/eeg-qa
Watch
1
0
Fork
You've already forked eeg-qa
 0
Code Issues Pull requests 1 Projects Releases Packages 3 Wiki Activity Actions

docs: corrige referências desatualizadas a Basic Auth e ADRs faltando na nav #71

Merged
jhony75 merged 1 commit from docs/automation-contract-followup into develop 2026-09-12 22:53:56 -03:00
Conversation 0 Commits 1 Files changed 8 +38 -11
jhony75 commented 2026-09-12 02:45:32 -03:00
Owner
Copy link

Auditoria de documentação pedida pelo usuário logo após a PR #70 (Automation Contract v1) ser mergeada e o deploy de dev validado ao vivo.

Achado principal: vários docs ainda descreviam Basic Auth como o mecanismo de auth ativo pro frontend/API -- estava correto até as PRs #67/#68/#69 (SSO via Authentik), mas ficou desatualizado depois. Corrigido em AI_HANDOFF.md, API_PLAYGROUND.md, BRUNO.md, DEPLOYMENT.md e DOCKER_ENVIRONMENTS.md, deixando explícito que o serviço de docs continua com Basic Auth (isso não mudou) -- só frontend/API migraram pra Authentik.

Achado mais sério: ADR-0014 e ADR-0015 não apareciam nem no índice (docs/adr/README.md) nem na navegação publicada (mkdocs.yml), e AUTOMATION_CONTRACT.md também estava fora da nav inteira -- todos ficariam praticamente invisíveis pra quem navegasse o site publicado (docs-eegqa.jonataslima.xyz), mesmo estando corretos e completos como conteúdo.

Também: ADR-0014 ganhou uma nota de atualização (2026-09-11) esclarecendo que a infra do Authentik já foi plugada de verdade -- o texto original do ADR ainda descrevia "ainda não plugado", que era verdade quando escrito, mas ficou superado.

Verificação: ./docs.sh build (mkdocs --strict) rodado localmente, sem erros -- confirma que os links novos/movidos resolvem certinho.

Auditoria de documentação pedida pelo usuário logo após a PR #70 (Automation Contract v1) ser mergeada e o deploy de dev validado ao vivo. **Achado principal**: vários docs ainda descreviam Basic Auth como o mecanismo de auth ativo pro frontend/API -- estava correto até as PRs #67/#68/#69 (SSO via Authentik), mas ficou desatualizado depois. Corrigido em `AI_HANDOFF.md`, `API_PLAYGROUND.md`, `BRUNO.md`, `DEPLOYMENT.md` e `DOCKER_ENVIRONMENTS.md`, deixando explícito que **o serviço de docs continua com Basic Auth** (isso não mudou) -- só frontend/API migraram pra Authentik. **Achado mais sério**: `ADR-0014` e `ADR-0015` não apareciam nem no índice (`docs/adr/README.md`) nem na navegação publicada (`mkdocs.yml`), e `AUTOMATION_CONTRACT.md` também estava fora da nav inteira -- todos ficariam praticamente invisíveis pra quem navegasse o site publicado (`docs-eegqa.jonataslima.xyz`), mesmo estando corretos e completos como conteúdo. Também: ADR-0014 ganhou uma nota de atualização (2026-09-11) esclarecendo que a infra do Authentik já foi plugada de verdade -- o texto original do ADR ainda descrevia "ainda não plugado", que era verdade quando escrito, mas ficou superado. **Verificação**: `./docs.sh build` (mkdocs `--strict`) rodado localmente, sem erros -- confirma que os links novos/movidos resolvem certinho.
docs: corrige referencias desatualizadas a Basic Auth e ADRs faltando na nav
All checks were successful
EEG QA CI / Detectar o que mudou (pull_request) Successful in 16s
Details
EEG QA CI / Backend (pull_request) Has been skipped
Details
EEG QA CI / Frontend (pull_request) Has been skipped
Details
EEG QA CI / Build e publicação de imagens (pull_request) Successful in 1m23s
Details
EEG QA CI / Deploy production (pull_request) Has been skipped
Details
EEG QA CI / Deploy development (pull_request) Has been skipped
Details
23eafab630 
Auditoria pos-merge da PR #70 encontrou documentacao que ainda descrevia
Basic Auth como o mecanismo ativo pro frontend/API (substituido por
forward-auth via Authentik desde as PRs #67/#68/#69) -- corrigido em
AI_HANDOFF.md, API_PLAYGROUND.md, BRUNO.md, DEPLOYMENT.md e
DOCKER_ENVIRONMENTS.md, deixando claro que o servico de docs continua
com Basic Auth (nao mudou).

Tambem corrigido: ADR-0014/ADR-0015 nao apareciam nem no indice
(docs/adr/README.md) nem na navegacao publicada (mkdocs.yml), e
AUTOMATION_CONTRACT.md nao estava em lugar nenhum da nav -- ficariam
invisiveis no site publicado. ADR-0014 ganhou uma nota de atualizacao
esclarecendo que a infra ja foi plugada (o texto original descrevia o
estado de antes).

Build estrito do mkdocs (--strict) validado localmente, sem erros.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
jhony75 merged commit cfba1c3561 into develop 2026-09-12 22:53:56 -03:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
jhony75/eeg-qa!71
No description provided.