docs: split usage guide out of README, add a docs index#3839
Merged
Conversation
README.md / README.zh-CN.md are now a lean landing page (intro, install, quick start, a minimal config, and a documentation index). The detailed configuration, permissions/sandbox, plugins (MCP), slash commands, @-references, and two-model setup move into docs/GUIDE.md (+ zh-CN), so end users get an approachable guide and the README stays scannable. Also fix stale MiMo preset facts in the guide and SPEC §5 to match config.Default(): base_url is token-plan-cn.xiaomimimo.com/v1, and the mimo-flash model is mimo-v2.5 (not mimo-v2-flash). Align the guide's built-in slash-command list with what /help prints.
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.
What
Restructure the README into a lean landing page and move the detailed how-to into a dedicated, bilingual guide.
README.md/README.zh-CN.md: intro, install, quick start, a minimalreasonix.toml, and a new Documentation index. The exhaustive configuration, permissions/sandbox, plugins (MCP), slash commands,@-references, and two-model sections move out (~390 → ~190 lines).docs/GUIDE.md+docs/GUIDE.zh-CN.md(new): the user-facing guide those sections moved into.SPEC.mdstays the contributor contract; the guide cross-links to it for the full schema and roadmap.Fixes (verified against
config.Default())token-plan-cn.xiaomimimo.com/v1(wasapi.xiaomimimo.com/v1) and themimo-flashmodel ismimo-v2.5(wasmimo-v2-flash) — corrected in the guide andSPEC.md§5./helpprints.All recent additions to these files (code signing,
max_steps/planner_max_steps,bash_timeout_seconds,excluded_paths, the rule-based permission model, MCP background auto-connect,/clear,auto_plan = off|on,/auto-plan) are preserved — just relocated into the guide.No code changes.