[failproofai-520] Restructure docs nav: product tabs replace Docs/Examples#517
Conversation
…mples Promote the two products to top-level navigation tabs and flatten each product's Docs/Examples into sidebar groups: - navigation.products[] (product dropdown) -> navigation.languages[].tabs[] - AgentEye -> "Agent Observability" (first tab); FailproofAI -> "Agent Enforcement" - tab icons removed; global anchors + all localized page refs preserved (15 langs) Verified: `mintlify validate` passes, and the translate-docs nav regenerator (scripts/translate-docs/mintlify-nav.ts) reproduces this structure byte-for-byte, so a future translation run won't revert it. The AgentEye doc-sync pipeline only writes docs/agenteye/* and never touches docs.json. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DXM3VDBtiSgefQCiSeXPV8
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe documentation navigation changes from product-driven tabs to localized Agent Observability and Agent Enforcement tabs, with product Docs and Examples groups moved into sidebars. The changelog records the restructure and navigation regeneration verification. ChangesDocumentation navigation
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DXM3VDBtiSgefQCiSeXPV8
What
Restructures the docs-site navigation (
docs/docs.json) so the two productsare the top-level tabs instead of a product dropdown, and the per-product
Docs/Examplestabs move into the sidebar.Docs·Examples(tabs)Agent Observability·Agent Enforcement(tabs)FailproofAI ▾dropdownConcretely:
navigation.products[]→navigation.languages[].tabs[]; AgentEye→ "Agent Observability" (first tab), FailproofAI → "Agent Enforcement";
globalanchors (GitHub/npm/Discord) and all localized page references arepreserved across all 15 languages.
Why
Product tabs read more clearly than a dropdown + generic Docs/Examples tabs, and
surface both products at the top level.
Verification
mintlify validate→success build validation passed(thedocsCI job'sstructure + nav-link-resolution check).
scripts/translate-docs/cli.ts --update-nav --languages zh,ja,…,he(
mintlify-nav.ts) against the newdocs.json— it reproduces this treebyte-for-byte, so a future
translate-docsrun won't revert the change.FailproofAI/agenteye'sscripts/export-mintlify-docs.sh+sync-mintlify-docs.ymlonly writedocs/agenteye/*andgit add docs/agenteye— they never touchdocs.json.The nav's 20 AgentEye slugs match the export exactly; committed docs are in sync.
validate:mdxunaffected(no MDX content changed).
Note (intended side effect)
Because Agent Observability is now the first tab, the site root
/redirectsto
/agenteye/getting-startedinstead of/introduction. This follows frommaking it the left-most/default tab. Happy to pin the homepage back to the
FailproofAI intro with a redirect if preferred.
Summary by CodeRabbit