Skip to content

docs(audit): align every published number with the code and harden check:docs-counts - #12200

Merged
diegosouzapw merged 2 commits into
release/v3.8.51from
docs/audit-v3851-fase2
Aug 31, 2026
Merged

diegosouzapw merged 2 commits into
release/v3.8.51from
docs/audit-v3851-fase2

Conversation

@diegosouzapw

Copy link
Copy Markdown
Collaborator

O que é

Fase 2 (execução) da auditoria profunda código × documentação de 2026-08-31 — fase 1 (levantamento, ~90 divergências com arquivo:linha) está em _tasks/research/2026-08-31-auditoria-readme-docs-vs-codigo-v3851.md.

Docs-only + gate: nenhuma mudança de comportamento de runtime.

Números alinhados ao código medido

352 providers · 167 migrations · 110 MCP tools / 33 scopes (45 canonical) · 15 factors · 6 mode packs · 7 auto-variants · 19 strategies · 12 engines · 122 db modules · 446 free-tier entries / 38 pools / 53 free-forever / 152 hasFree · 6 A2A skills · 4 cloud agents (+cursor-cloud) · 5 embedded services (+dario) · 15 ACP agents · 43 locales · versão 3.8.51 — em README, llm.txt (+42 espelhos re-sincronizados), 10 SVGs/mmds (incl. tier-flow-*.svg servidos no onboarding), AGENTS.md e 25+ docs.

Correções semânticas (não só número)

  • Breaker: AGENTS.md/README/resilience-layers.svg agora descrevem o wiring real (circuitBreakerThreshold 8/12/2 + estado DEGRADED); providerFailureThreshold (10/15/2) é documentado como sem consumidor no runtime — decidir remover/ligar fica para um PR de código.
  • Webhooks: 3 eventos fantasma removidos (provider.error/provider.recovered/combo.switched); o doc parava de negar a tabela webhook_deliveries (migração 069) e ganha as rotas/kinds reais.
  • ROUTE_GUARD_TIERS: tabelas regeneradas do código — 42 prefixos + 4 patterns LOCAL_ONLY e 6 ALWAYS_PROTECTED (antes espelhava 19/46 e 2/6).
  • API_REFERENCE: 7 endpoints fantasma corrigidos para os reais; claim “Complete” substituído por escopo honesto apontando openapi.yaml.
  • REASONING_REPLAY: cache 200 (não 2000); clamp do endpoint [1, 200].
  • Órfão promise-pillars.svg da raiz removido (nenhuma referência; a cópia canônica vive em docs/diagrams/).

Gate endurecido (check:docs-counts)

Novas regras STRICT: versão em prosa (rodapé do README + llm.txt vs package.json), formas reescritas que evadiam os patterns (N recurring/keyless free-forever, N-tool, N versioned SQL migration files), claims novos de catálogo (446 entries / 38 recurring pools com skip do subset positivo) e superfície ampliada (llm.txt, open-sse/mcp-server/README.md, skills/omni-mcp/SKILL.md, public/images/tier-flow-*.svg). +5 testes de regressão em tests/unit/check-docs-counts-sync.test.ts (33/33 verdes).

Validação

  • check:docs-counts ✅ (com as regras novas) · docs-sync ✅ · doc-links ✅ · fabricated-docs ✅ · env-doc-sync ✅ · api-docs-refs ✅ · docs-symbols ✅
  • node --import tsx/esm --test tests/unit/check-docs-counts-sync.test.ts → 33 pass / 0 fail
  • Base verde no corte (sem issue base-red aberta para release/v3.8.51).

…eck:docs-counts

Fase 2 of the 2026-08-31 code-vs-docs audit (fase 1 report:
_tasks/research/2026-08-31-auditoria-readme-docs-vs-codigo-v3851.md).

README/llm.txt (+42 mirrors)/SVGs/mmds and 25+ docs updated to the measured
counts (352 providers, 167 migrations, 110 MCP tools/33 scopes, 45 canonical,
15 factors, 6 mode packs, 19 strategies, 12 engines, 122 db modules, 446
free-tier entries/38 pools/53 free-forever/152 hasFree, 6 A2A skills, 4 cloud
agents, 5 embedded services, 15 ACP agents, 43 locales, v3.8.51).

Semantic fixes: the provider breaker tables now describe the runtime wiring
(circuitBreakerThreshold 8/12/2 + DEGRADED state; providerFailureThreshold is
documented as having no runtime consumer), webhooks docs drop 3 phantom events
and stop denying the webhook_deliveries table, ROUTE_GUARD_TIERS mirrors the
full 42-prefix/4-pattern/6-always-protected sets, API_REFERENCE drops 7
phantom endpoints, REASONING_REPLAY cache is 200 (not 2000).

check:docs-counts hardened: version-prose check (README footer + llm.txt vs
package.json), rewritten free-forever/N-tool/SQL-migration-files patterns,
catalog entries + recurring pools claims, llm.txt/mcp-server README/omni-mcp
SKILL/tier-flow SVGs added to the gated surface; +5 regression tests.
@rafacpti23

Copy link
Copy Markdown
Contributor

Parabens, vamos continuar evoluindo assim cada vez mais, Otimo PR

…remaining surfaces

The Merge-integrity job caught skills/omni-mcp/SKILL.md being edited by hand:
it is generated from src/shared/constants/agentSkills.ts, which still said
107 tools / 32 scopes. Fix the source (generator now reproduces the corrected
output verbatim — 46/46 unchanged) and sweep the same stale family from the
surfaces the audit partition missed: skills/README.md, CONTRIBUTING.md,
docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md, docs/guides/SETUP_GUIDE.md,
the Copilot driver system prompt (37 -> 110) and the omni-mcp description
string in 39 locale files (37/107 -> 110, 16/32 -> 33).
@diegosouzapw
diegosouzapw merged commit 6706c38 into release/v3.8.51 Aug 31, 2026
21 checks passed
@diegosouzapw
diegosouzapw deleted the docs/audit-v3851-fase2 branch August 31, 2026 16:39
muhamadgalihsaputra pushed a commit to niyatna/NiyatnaRoute that referenced this pull request Sep 27, 2026
…eck:docs-counts (cheaper-inference#12200)

Fase 2 da auditoria código×docs 2026-08-31: ~90 divergências corrigidas em README/llm.txt(+42 espelhos)/SVGs/AGENTS.md/25+ docs; correções semânticas (breaker 8/12/2 + DEGRADED, webhooks sem eventos fantasma, ROUTE_GUARD_TIERS completo, API_REFERENCE sem fantasmas, reasoning 200); gate check:docs-counts endurecido (versão em prosa, patterns anti-evasão, superfície +llm.txt/mcp-server/omni-mcp/tier-flow) +5 testes; fonte do gerador de agent-skills corrigida (107/32 → 110/33) e mesma família varrida do Copilot prompt, 39 locales, skills/README, CONTRIBUTING e 2 guias.
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.

2 participants