Skip to content

[failproofai-520] Restructure docs nav: product tabs replace Docs/Examples#517

Merged
NiveditJain merged 2 commits into
mainfrom
luv-520
Jul 15, 2026
Merged

[failproofai-520] Restructure docs nav: product tabs replace Docs/Examples#517
NiveditJain merged 2 commits into
mainfrom
luv-520

Conversation

@NiveditJain

@NiveditJain NiveditJain commented Jul 15, 2026

Copy link
Copy Markdown
Member

What

Restructures the docs-site navigation (docs/docs.json) so the two products
are the top-level tabs
instead of a product dropdown, and the per-product
Docs/Examples tabs move into the sidebar.

Before After
Top options Docs · Examples (tabs) Agent Observability · Agent Enforcement (tabs)
Product switch FailproofAI ▾ dropdown (removed — products are now the tabs)
Docs / Examples groups inside the Docs/Examples tabs flat in the sidebar under each product
Tab icons shield-check / eye removed

Concretely: navigation.products[]navigation.languages[].tabs[]; AgentEye
→ "Agent Observability"
(first tab), FailproofAI → "Agent Enforcement";
global anchors (GitHub/npm/Discord) and all localized page references are
preserved 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 validatesuccess build validation passed (the docs CI job's
    structure + nav-link-resolution check).
  • Translation pipeline is idempotent with this structure. Ran
    scripts/translate-docs/cli.ts --update-nav --languages zh,ja,…,he
    (mintlify-nav.ts) against the new docs.json — it reproduces this tree
    byte-for-byte, so a future translate-docs run won't revert the change.
  • AgentEye doc-sync pipeline is unaffected. FailproofAI/agenteye's
    scripts/export-mintlify-docs.sh + sync-mintlify-docs.yml only write
    docs/agenteye/* and git add docs/agenteye — they never touch docs.json.
    The nav's 20 AgentEye slugs match the export exactly; committed docs are in sync.
  • ✅ All 600 nav page refs resolve to existing files; validate:mdx unaffected
    (no MDX content changed).

Note (intended side effect)

Because Agent Observability is now the first tab, the site root / redirects
to /agenteye/getting-started instead of /introduction. This follows from
making it the left-most/default tab. Happy to pin the homepage back to the
FailproofAI intro with a redirect if preferred.

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation navigation around two top-level tabs: Agent Observability and Agent Enforcement.
    • Moved product documentation and examples into the sidebar for easier access.
    • Added localized navigation support across multiple interface languages.
    • Removed tab icon styling for a cleaner navigation experience.
    • Documented verification for idempotency and translation regeneration.

…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
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 41eece84-7779-47e6-b592-4b31168117e7

📥 Commits

Reviewing files that changed from the base of the PR and between f04a2cd and 60fa832.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • docs/docs.json

📝 Walkthrough

Walkthrough

The 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.

Changes

Documentation navigation

Layer / File(s) Summary
Multilingual navigation configuration
docs/docs.json, CHANGELOG.md
Replaces the product-based navigation with localized Agent Observability and Agent Enforcement tabs, sidebar groups, language-prefixed routes, and a changelog entry documenting the change.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related PRs

Suggested labels: enhancement

Suggested reviewers: github-actions[bot], siddarthaa

Poem

I hopped through tabs beneath the light,
Two tidy paths now guide the site.
Observability, Enforcement bright,
Sidebars bloom with pages right.
The docs regenerate clean tonight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main docs navigation restructure and matches the changeset.
Description check ✅ Passed The description covers what, why, and verification well, but it omits the template's Type of Change and Checklist sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot added the enhancement New feature or request label Jul 15, 2026
@NiveditJain NiveditJain merged commit fb97700 into main Jul 15, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants