Skip to content

docs: atualiza README e documentação de entrada ao estado de 2026-10-15 - #70

Merged
hbgit merged 8 commits into
developfrom
docs/atualiza-readme-e-docs
Oct 15, 2026
Merged

hbgit merged 8 commits into
developfrom
docs/atualiza-readme-e-docs

Conversation

@hbgit

@hbgit hbgit commented Oct 15, 2026

Copy link
Copy Markdown
Owner

Problema

O README.md não mudava desde 2026-09-19 e os documentos de entrada tinham ficado para trás em relação ao código. Exemplos: o backend aparecia como "dart:io, sem framework" (é Serverpod), o login do ACS como "demonstrativo", a CI com "quatro jobs" (são nove), "25 testes", piso de Dart >=3.3.0, autenticação e RBAC como "pendentes", e não havia instrução para rodar o admin.

O que mudou

  • README.md
    • Atualiza estado atual, funcionalidades por app, estrutura do repositório e segurança e escopo.
    • Move ## Configuração (bootstrap_env.sh) para antes de ## Execução local.
    • Acrescenta o backoffice, com a emissão do código de ativação do ADM-001 (bin/issue_staff_activation_code.dart com SERVERPOD_DATABASE_PASSWORD).
    • Corrige a assinatura de release: só o ACS recusa a chave de debug.
    • Lista os nove jobs de CI, conferidos contra ci.yml, e troca as contagens de testes pelos comandos.
  • CONTRIBUTING.md: piso de Dart (3.12 efetivo nos apps, por causa de sinalacs_client), bootstrap_env.sh, execução do admin e o conferidor de links.
  • apps/acs, apps/patient, apps/admin/README.md: descrições atuais, ressalvas do Keystore (provado só no emulador API 36) e o código de ativação do admin.
  • backend/sinalacs_server/README.md: troca o modelo do Serverpod (que mandava subir Redis) pelo caminho do repositório.
  • docs/telas-paciente.md: OTP e QR reais, alerta real (locationHash + locationCell de ~1,1 km), aba Status com alerts.statusFor, triagem com seis perguntas e risco no servidor, lembretes com notificação local.
  • docs/README.md: índice com a auditoria da CI e o showcase.
  • .github/SECURITY.md: escopo passa a incluir apps/admin e scripts/.
  • scripts/qa/check_documentation_links.sh: ignora .worktrees/ e docs/superpowers/plans/. Os links de exemplo dos planos eram resolvidos a partir do próprio plano e deixavam o script vermelho. Um link quebrado de verdade continua sendo pego (testado com arquivo temporário).
  • Plano: docs/superpowers/plans/2026-10-15-atualizacao-documentacao.md.

Toda afirmação nova foi conferida no código. Uma revisão final de contexto limpo apontou 6 itens importantes, todos corrigidos em 1b1f05a.

Testes

  • bash scripts/qa/check_documentation_links.sh: sai com 0 sem filtro; com um link quebrado temporário, sai com 1.
  • Varredura por frases desatualizadas (rg) nos arquivos tocados: nenhuma ocorrência.
  • Os nove jobs citados no README batem com o bloco jobs: de ci.yml.
  • Suítes de apps e backend não rodadas: nenhum código de produção mudou.

Impacto em privacidade/segurança

Nenhum comportamento muda. Os textos de segurança e privacidade ficaram mais precisos: locationCell legível pelo servidor, ressalvas do Keystore e mTLS só na stack local.

Fora do escopo (pendências conhecidas)

  • spec/validation_report.md, test_plan.md, sys_flow.md, security_assessment.md, docs/showcase/, video/ e o endpoint.md gerado.
  • Itens menores ainda abertos:
    • o CONTRIBUTING ainda diz que os apps não têm integração ponta a ponta;
    • o README sugere o procedimento do ACS para gerar o APK do paciente;
    • falta o comando do Postgres de teste (--profile test);
    • a release local do ACS também precisa de -Psinalacs.allowDevClientKey=true;
    • na seção do paciente, sync_dev_ca.sh aparece depois de flutter run;
    • falta citar REQUIRE_ACS_MFA=false em dev;
    • os blocos com cd relativo falham se colados de uma vez;
    • o resumo da CI no CONTRIBUTING está incompleto.

🤖 Generated with Claude Code

hbgit added 8 commits October 15, 2026 11:30
…ança

Conferido no código: OTP (auth.verifyOtp), QR (qr_scanner.dart), alerta real
(createRedAlert com locationHash), status (statusFor), lembretes
(LocalNotificationsReminderScheduler), aviso de termos e push.
- emissão do código de ativação com SERVERPOD_DATABASE_PASSWORD e sem <>
- admin web: host e CA de dev do navegador, caminho não validado
- piso efetivo de Dart 3.12 nos apps (vem de sinalacs_client)
- locationCell (~1,1 km) além do hash na localização do alerta
- ressalvas da ligação do token ao Keystore (só API 36; PIN no API 30+)
- triagem com seis perguntas de sim/não, risco calculado no servidor
…perpowers/plans

Os planos citam trechos de outros arquivos com links relativos ao arquivo de
origem; o conferidor os resolvia a partir do plano e saía com 1.
@hbgit
hbgit merged commit d74d5a1 into develop Oct 15, 2026
10 checks passed
@hbgit
hbgit deleted the docs/atualiza-readme-e-docs branch October 15, 2026 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant