docs: merge documentation into readme - #4
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR consolidates the repository’s standalone documentation (previously under docs/) into the root README files, and updates internal references accordingly so the docs live in one place per language.
Changes:
- Moved the English documentation content into
README.mdand the Chinese mirror intoREADME.zh-CN.md. - Updated contribution/agent/skill guidance to link to README sections instead of
docs/*files. - Removed the
docs/documentation tree from the repository.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces the previous “Documentation” section with the consolidated user/developer docs content. |
| README.zh-CN.md | Mirrors the consolidated documentation in Chinese (user guide, design notes, development guide). |
| docs/user/guide.md | Removed (content moved into root README). |
| docs/user/guide.zh-CN.md | Removed (content moved into root README.zh-CN.md). |
| docs/README.md | Removed (docs tree index no longer needed). |
| docs/README.zh-CN.md | Removed (docs tree index no longer needed). |
| docs/developer/design.md | Removed (content moved into root README). |
| docs/developer/design.zh-CN.md | Removed (content moved into root README.zh-CN.md). |
| docs/developer/development.md | Removed (content moved into root README). |
| docs/developer/development.zh-CN.md | Removed (content moved into root README.zh-CN.md). |
| CONTRIBUTING.md | Updates guidance and links to point to relevant sections in README.md. |
| CONTRIBUTING.zh-CN.md | Updates guidance and links to point to relevant sections in README.zh-CN.md. |
| built-in/skill/arc-cli-usage/SKILL.md | Updates documentation source references to use README.md (and relevant anchors) instead of docs/*. |
| AGENTS.md | Updates references to point at root READMEs instead of the removed docs/* files. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+255
to
+258
| | Claude Code | `./.claude/skills/<name>` | | ||
| | Codex | `./.codex/skills/<name>` | | ||
| | Cursor CLI | `./.cursor/skills-cursor/<name>` | | ||
| | OpenCode | `./.opencode/skills/<name>` | |
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
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.
Merge the standalone docs tree into the root README files and remove the docs directory.
Verification: