[ef-43] feat: add Mintlify documentation configuration#43
Merged
Conversation
Add mint.json config and adapt existing docs for Mintlify: - Create docs/mint.json with navigation, branding, and links - Add YAML frontmatter (title, description, icon) to all 9 doc pages - Replace docs/index.md with docs/introduction.md as Mintlify landing page - Convert internal links from ./file.md to /file format - Fix external link to CONTRIBUTING.md to use GitHub URL Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (2)
📝 WalkthroughWalkthroughConverted many docs pages from H1 headings to YAML frontmatter, removed Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/introduction.md (1)
17-19: Consider avoiding hardcoded policy count in docs copy.Line 17 (“35+ Built-in Policies”) can go stale as policies evolve. Prefer non-numeric wording unless this is updated as part of each release checklist.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/introduction.md` around lines 17 - 19, The "35+ Built-in Policies" hardcoded count should be removed to avoid stale copy: update the Card component title attribute and visible text (currently "35+ Built-in Policies") to a non-numeric phrase such as "Built-in Policies" or "Many Built-in Policies" and keep the description line unchanged; locate the Card element with title="35+ Built-in Policies" and replace that title string and the matching label inside the Card to the chosen non-numeric wording.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/introduction.md`:
- Around line 17-19: The "35+ Built-in Policies" hardcoded count should be
removed to avoid stale copy: update the Card component title attribute and
visible text (currently "35+ Built-in Policies") to a non-numeric phrase such as
"Built-in Policies" or "Many Built-in Policies" and keep the description line
unchanged; locate the Card element with title="35+ Built-in Policies" and
replace that title string and the matching label inside the Card to the chosen
non-numeric wording.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 05017a88-ba13-4054-8c05-fb29c34510ca
📒 Files selected for processing (12)
docs/architecture.mddocs/built-in-policies.mddocs/cli-reference.mddocs/configuration.mddocs/custom-hooks.mddocs/dashboard.mddocs/getting-started.mddocs/index.mddocs/introduction.mddocs/mint.jsondocs/package-aliases.mddocs/testing.md
💤 Files with no reviewable changes (1)
- docs/index.md
Revert internal links back to ./file.md format so docs are navigable on GitHub. Mintlify handles both formats. Also replace Mintlify-only Card/CardGroup components with standard markdown tables. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/testing.md (1)
260-260:⚠️ Potential issue | 🟡 MinorUse a stable GitHub URL for the Contributing link.
Line 260 currently points to
../CONTRIBUTING.md, which can break in hosted docs. Link directly to the repository file instead.Suggested fix
-See [Contributing](../CONTRIBUTING.md) for the complete pre-merge checklist. +See [Contributing](https://github.com/exospherehost/failproofai/blob/main/CONTRIBUTING.md) for the complete pre-merge checklist.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/testing.md` at line 260, Replace the relative link "See [Contributing](../CONTRIBUTING.md)" in docs/testing.md with a stable GitHub URL to the repository's CONTRIBUTING.md (e.g., https://github.com/<OWNER>/<REPO>/blob/<BRANCH>/CONTRIBUTING.md) so hosted docs won't break; locate the exact occurrence of the string "See [Contributing](../CONTRIBUTING.md)" and update the markdown link target to the repository-level absolute GitHub URL (use the correct owner/repo/branch for this repo).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/testing.md`:
- Line 260: Replace the relative link "See [Contributing](../CONTRIBUTING.md)"
in docs/testing.md with a stable GitHub URL to the repository's CONTRIBUTING.md
(e.g., https://github.com/<OWNER>/<REPO>/blob/<BRANCH>/CONTRIBUTING.md) so
hosted docs won't break; locate the exact occurrence of the string "See
[Contributing](../CONTRIBUTING.md)" and update the markdown link target to the
repository-level absolute GitHub URL (use the correct owner/repo/branch for this
repo).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a92172f1-2db7-4289-9859-82e533cba789
📒 Files selected for processing (4)
docs/configuration.mddocs/getting-started.mddocs/introduction.mddocs/testing.md
✅ Files skipped from review due to trivial changes (1)
- docs/introduction.md
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/getting-started.md
- docs/configuration.md
- Replace mint.json with docs.json using luma theme and Claudeye colors - Add Exosphere logo PNGs and favicon from exosphere.host - Add docs, npm, license, CI, and Discord badges to README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
GitHub API can't detect the license due to Commons Clause addendum. Use a static shields.io badge instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/mint.jsonMintlify configuration with navigation groups, branding colors, and GitHub/npm linksdocs/index.mdwithdocs/introduction.mdas Mintlify landing page with Card components./file.mdto/fileformat for Mintlify routingTest plan
npx mintlify devfromdocs/and verify all pages render correctly🤖 Generated with Claude Code
Summary by CodeRabbit