docs: overhaul guides and redesign the documentation site - #817
Merged
Conversation
Entire-Checkpoint: 01M1TJ1CYCXYDWDZZQ1DFBZ1GZ
|
Too many files changed for review (122 files, 100 file limit). Bypass the limit by tagging |
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited) Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (122)
📝 WalkthroughWalkthroughThis change rebuilds the documentation site structure and homepage, adds CLI-doc generation and link validation scripts, rewrites guides and provider references, updates configuration and environment reference docs, and refreshes contributor and test documentation. ChangesDocumentation overhaul
Estimated code review effort: 4 (Complex) | ~60 minutes Poem
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 |
Contributor
Instruction countsThe comparison never ran — an earlier step failed.
|
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.
Make setup and ongoing use easier to follow across the README and documentation site. Reorganize navigation by task, rewrite onboarding and provider guidance, and correct configuration, authentication, caching, and migration examples. For example, JSON migration now extracts
.secretsbefore import, and profile examples putif_missingon individual secrets.Redesign the landing page with an interactive vault/encryption example, clearer calls to action, responsive layouts, and light/dark themes. Improve documentation typography, keyboard focus, and sponsor contrast. Add dedicated troubleshooting and Passwordstate guides, plus maintained examples and related links for all 41 CLI commands. CLI regeneration preserves those additions, and the production build now checks rendered internal links and anchors.
Validation:
AI-assisted — Tool: Codex; model: openai/unavailable; version: unavailable.
Note
Low Risk
Documentation, site assets, and build-time link checks only; no runtime or secret-handling code changes in this diff.
Overview
This PR reshapes onboarding and contributor docs (
README.md,CONTRIBUTING.md,AGENTS.md): shorter product pitch, task-oriented dev commands,fnox-corepaths in the agent guide, clearer hierarchical-config wording, and mbx version references tied tomise.tomlinstead of hard-coded versions.The VitePress site gets a custom landing page (
HomePage.vue), light/dark theming with bundled Space Grotesk, section-specific sidebars vianavigation.mjs, nav that starts at quick start, edit links, and sponsor styling fixes. CLI reference is augmented bycli-examples.jsonandenrich-cli.mjs, which inject frontmatter, examples, and related links into generated command pages afterrender:usage.Guides are rewritten for accuracy and task flow (how it works, golden path, leases with
env = falseon bootstrap secrets, daemon/check --all, import-export migration withjq '.secrets'). The docs contributor guide documents layout, writing rules, and the generation pipeline. Production builds gaincheck-links.mjsto validate internal URLs and anchors in rendered HTML.Reviewed by Cursor Bugbot for commit 28cfa80. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit