[failproofai-540] docs: add contextual menu (copy-to-LLM + ask AI) to docs pages#540
Conversation
… docs pages (#540) Enable Mintlify's `contextual` menu in docs/docs.json so every docs page (all tabs, all 15 locales) offers: copy/view as Markdown, hand-off to ChatGPT / Claude / Perplexity, open in MCP / Cursor / VS Code, and an "Ask a question" AI-assistant option. It's a single global setting, so no per-page edits are needed. The `assistant` option additionally requires enabling the assistant in the Mintlify dashboard. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013hyh7mTnLAwixTrAeHx4gH
|
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)
📝 WalkthroughWalkthroughAdds a top-level contextual menu configuration to the docs site with actions for copying, viewing, sharing, and questioning pages. Updates the changelog with the available options and assistant requirement. ChangesContextual documentation menu
Estimated code review effort: 1 (Trivial) | ~2 minutes 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 |
|
Automated code review started - full review. Results will be posted here. |
|
✅ Build & test complete. Results:
Posting detailed review next. |
🔍 Automated Code Review📋 Executive SummaryThis PR adds a Mintlify per-page contextual menu to the FailproofAI docs site — a single global config block in 📊 Change Architecturegraph TD
A["docs/docs.json
(+13 lines)"] -->|"adds contextual block
with 9 options"| B[Mintlify build pipeline]
B --> C["Static site generation
(all 15 locales x 2 tabs)"]
C --> D["Per-page contextual menu
(copy, view, LLM hand-off, IDE open, AI ask)"]
E["CHANGELOG.md
(+1 line)"] -->|"docs entry at line 40"| F[0.0.14-beta.1 section]
style A fill:#87CEEB
style E fill:#87CEEB
style D fill:#90EE90,color:#000
style C fill:#90EE90,color:#000
subgraph "Untouched"
G[Navigation - 15 locales]
H[Mintlify schema '$schema']
I[Colors, logo, favicon]
J[All 621 MDX pages]
end
Legend: 🟢 New | 🔵 Modified | 🟡 Breaking Change Risk 🔴 Breaking Changes✅ No breaking changes detected. The
|
| Check | Result |
|---|---|
| JSON well-formed? | ✅ python3 -m json.tool passes |
| All contextual options valid? | ✅ All 9 match Mintlify official docs |
| Duplicate keys? | ✅ None |
| Navigation corrupted? | ✅ All 15 locales verified intact |
| Required keys preserved? | ✅ $schema, theme, name, colors, logo, favicon, navigation all present |
$schema reference correct? |
✅ https://mintlify.com/docs.json |
| MDX pages still parse? | ✅ 621 pages clean |
| All unit tests pass? | ✅ 2078 tests pass (121 files) |
| CHANGELOG placement correct? | ✅ Under 0.0.14-beta.1 -> ### Docs |
🧪 Evidence — Build & Test Results
JSON Validation
All options recognized by Mintlify ✓
Options (9): copy, view, assistant, chatgpt, claude, perplexity, mcp, cursor, vscode
Validation PASSED ✓
Languages: en, zh, ja, ko, es, pt-BR, de, fr, ru, hi, tr, vi, it, ar, he (15 locales)
Navigation structure intact ✓
All checks passed ✓
Test Results
Test Files 121 passed (121)
Tests 2078 passed (2078)
Duration 68.25s
MDX Validation
621 MDX page(s) parsed cleanly
🔗 Issue Linkage
👥 Human Review Feedback
No human review comments on this PR. Only bot comments from coderabbitai (rate-limited, no actionable feedback) and hermes-exosphere (review-started marker). No unresolved review threads.
💡 Suggestions
- Add
grokto the contextual menu options — xAI's Grok is officially supported by Mintlify and could benefit users who use Grok for agent-related research. - Consider adding
download-pdf— Mintlify supports one-click PDF export. If FailproofAI users would benefit from downloading pages as PDFs (e.g., for offline reference or sharing with non-technical stakeholders), this is a zero-config addition. - PR body caveat -> docs page note: The "Ask a question" assistant requires the Mintlify Pro plan + enabling in the dashboard. Consider adding a small note to the docs homepage or a tooltip so users exploring the docs know why "Ask a question" might not work immediately after deploy.
🏆 Verdict
VERDICT: APPROVED
Automated code review · 2026-07-16 20:22:00 UTC
hermes-exosphere
left a comment
There was a problem hiding this comment.
Automated review: Approved. ✅
No breaking changes, all config valid, all tests pass (2078/2078), MDX clean (621 pages).
Minor suggestions (non-blocking):
- Consider adding 'grok' and 'download-pdf' to contextual menu options
- Document assistant-enablement caveat on docs site
hermes-exosphere
left a comment
There was a problem hiding this comment.
Automated review: Approved. ✅
What
Enable Mintlify's per-page contextual menu (
contextualindocs/docs.json) so every docs page — all tabs, all 15 locales — offers readers:It's a single global setting, so no per-page edits are required.
Manual follow-up (dashboard)
The
assistant("Ask a question") option only functions once the assistant is toggled on in the Mintlify dashboard (app.mintlify.com/products/assistant, Pro plan and above). The copy-to-LLM options work immediately on deploy. Mintlify has no literal per-line ask — the assistant answers about the page (and the whole docs).Testing
docs.jsonre-parses as valid JSON;contextual.optionsset as expected.main(docs: migrate community Discord link to branded discord.befailproof.ai #539) — the branded Discord link and this change coexist cleanly.mintCLI isn't available in this environment, somint validatewasn't run; config-only change, no pages/links touched.Changelog
Added under
### Docsin0.0.14-beta.1.🤖 Generated with Claude Code
https://claude.ai/code/session_013hyh7mTnLAwixTrAeHx4gH
Summary by CodeRabbit
New Features
Documentation