docs: streamline READMEs, add RDK board skills + Chinese versions#10
Merged
Conversation
The root and npm READMEs had grown to 399 and 564 lines, mixing the user quick-start with maintainer/architecture/embedding internals, so a new reader could not tell at a glance what Moss is or do anything quickly. - README.md: 399 → ~210 lines. Tight one-line hero, then quick-start, why, everyday use, board connect, long-running tasks, models, safety, skills/MCP, embedding, and one links section for the maintainer docs (AGENTS.md, roadmap, host-adapter contract, release checklist) that used to be inlined. All readme-accuracy.spec tokens preserved. - New "Give Moss RDK Board Skills" section: what the device-knowledge skill pack (rdk-device / rdk-ros / rdk-peripheral-cookbook / …) unlocks on a connected board, and the three ways to load it (default skill root, skills.extraRoots config, or in-workspace skills/ auto-discovery). - packages/dmoss-agent/README.md: 564 → ~170 lines, refocused on the npm package's real value — the embeddable runtime (LLMProvider minimal path, DmossAgent quickstart, key API surface, streaming/hooks/goal) — with the duplicated CLI manual compressed to a pointer at the project README. - Chinese versions: README.zh-CN.md and packages/dmoss-agent/README.zh-CN.md, with a top-of-file language toggle on every README. Added the package zh README to the npm `files` allowlist so it ships. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Why
The root README (399 lines) and npm README (564 lines) had grown bloated — mixing the user quick-start with maintainer/architecture/embedding internals — so a new reader couldn't tell at a glance what Moss is, and there was no Chinese version.
What changed
README.md399 → ~210 lines. Tight one-line hero, then quick-start, why, everyday use, board connect, long-running tasks, models, safety, skills/MCP, embedding, and a single links section for the maintainer docs (AGENTS.md, roadmap, host-adapter contract, release checklist) that used to be inlined. Allreadme-accuracy.spectokens preserved (board mode,/disconnect,--hybrid, resume section,Shift+Tab,/yolo, every--ask-for-approvalvalue,moss doctor).rdk-device/rdk-ros/rdk-peripheral-cookbook/rdk-board-knowledge/ …) unlocks on a connected board, and the three verified ways to load it: a default skill root (~/.agents/skills), theskills.extraRootsconfig key, or in-workspaceskills/auto-discovery.packages/dmoss-agent/README.md564 → ~170 lines — refocused on the npm package's real value (the embeddable runtime:LLMProviderminimal path,DmossAgentquickstart, key API surface, streaming/hooks/goal), with the duplicated CLI manual compressed to a pointer at the project README. Keeps/resume.README.zh-CN.mdandpackages/dmoss-agent/README.zh-CN.md, each README gets a top-of-fileEnglish · 简体中文toggle. The package zh README is added to the npmfilesallowlist so it ships.Verification
npm run verifygreen locally (one timing-flake in thecli-tui-command-guardTUI drive test on the first run, passed standalone and on a clean re-run — unrelated to docs).check:hygienepasses: all relative links and anchors resolve, including the cross-file CJK anchor from the package zh README to the root zh board-skills section.