Skip to content

docs: fresh-eyes audit of the July cleanup#728

Draft
ashpreetbedi wants to merge 95 commits into
mainfrom
docs-review-20260711
Draft

docs: fresh-eyes audit of the July cleanup#728
ashpreetbedi wants to merge 95 commits into
mainfrom
docs-review-20260711

Conversation

@ashpreetbedi

Copy link
Copy Markdown
Contributor

Summary

This is the independent fresh-eyes audit of the July documentation cleanup, grounded in Agno v2.7.2 (81f50c2389e9710a3aab9fdd298a7215c264b986) and clean origin/main snapshots of the referenced templates.

  • Reviewed all 626 initial navigation chunks covering 3,737 unique pages, then ran targeted post-generation, post-fix, and randomized convergence reviews.
  • Corrected source accuracy, setup, navigation, descriptions, and reader experience across the documentation.
  • Hardened the cookbook-to-docs generator so curated corrections survive regeneration.
  • Updated 2,768 files while preserving every existing page. This PR contains zero file deletions.

The audit found repeated defect classes across the site: incorrect model IDs, invalid runtime-event attributes, incomplete dependency and service setup, generated tables built from truncated source comments, stale indexes, and underspecified descriptions.

What changed

  • Corrected model, provider, runtime, workflow, storage, memory, and tool behavior against pinned source.
  • Added required packages, environment variables, companion services, local files, and setup order to runnable guides.
  • Resolved navigation omissions and stale overview rows, including 105 reachable examples omitted from 37 indexes.
  • Applied 671 centrally resolved example-description updates.
  • Restored five legacy AgentOS CLI redirects.
  • Kept generated cookbook fences byte-identical to the pinned v2.7.2 source while recording source-only defects in the shared upstream ledger.
  • Verified 9/9 setup prompt snippets byte-identical to their source templates and checked 18 live consumers.

Audit accounting

  • Initial primary sweep: 478 accepted records across 379 files, including 129 accuracy, 56 voice, and 293 reader-experience records.
  • Examples FIND sweep: 1,118 candidates across 1,978 pages, including 364 install, 244 reader-experience, 239 description, and 172 accuracy records.
  • Post-generation verification: 308/308 chunks across 1,158 selected files, with 655 findings and 259 upstream occurrences fully accounted for. Errors and blockers: 0.
  • Post-fix verification: 278/278 units across 942 selected files. Accounting errors and blockers: 0.
  • Final randomized convergence: 15/15 units completed. Effective substantive findings: 0. One reported Anthropic finding was rejected against Anthropic's current code-execution documentation and pinned Agno source. One cosmetic title finding remains outside the substantive convergence threshold.

Final verification

  • Generator plan: 1,726 KEEP_VERBATIM, 329 PRESERVE_CURATED, 25 REGEN, 0 DELETE, 0 NEW.
  • Generator stability: title dedupe 0 changes; one-offs 0 changes; integrity 1,751 pages checked with 0 problems.
  • Inventory: 3,755 navigated pages; 0 missing navigation files; 0 unused media; 0 unused snippets; 0 redirect defects.
  • Links: 4,332 internal links checked; 0 broken links; 0 broken anchors.
  • Descriptions: 3,613 applicable navigation pages checked; 0 missing descriptions.
  • Install coverage: 0 offenders and 0 missing requirements.
  • Reference drift: 0 wrong defaults; 13 known intentional or unmappable shapes.
  • Imports: 568 unique statements checked; 0 real failures.
  • OpenAPI: 142 operations and 191 schemas; deep-equal outside five checked-in Slack enrichments.
  • Template setup prompts: 9/9 byte-identical.
  • Style: 0 em dashes outside fenced source code across 3,967 tracked MDX files.
  • Mintlify: mint broken-links and mint validate pass.
  • Diff hygiene: clean worktree, zero file deletions, and git diff --check passes.

Per the audit constraint, mint build was excluded.

Upstream flags

The final curation covers 915 source-only occurrences: 261 new roots, 174 combines, 105 immutable-ledger duplicates, 30 curated duplicates, 256 reviewed duplicates, and 89 prior rejects. The deterministic suffix contains 579 rendered root blocks and produces 717 semantic representatives.

The consolidated suffix was appended once to the shared ignored upstream ledger and verified byte-for-byte. Generated cookbook code and docstrings remain faithful to v2.7.2.

Deliberate states

  • The reviewed orphan set remains in place: hidden example indexes, held demo-os/** pages, and the router-choice trio.
  • Existing install allowlist and parked product decisions remain unchanged pending product-owner direction.
  • This PR proposes no page deletions.

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
agno 🟢 Ready View Preview Jul 16, 2026, 11:47 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
agno 🟡 Building Jul 16, 2026, 11:45 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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