fix(docs): rewrite agent-skills pages for newcomer-friendliness#129
Merged
Conversation
Overview: fix repo reference to generalupdate-skill-codegen, add 'What is an Agent Skill?' concept section, add multi-AI-tool integration guide (Claude Code, Copilot, Cursor, Windsurf, etc.) generalupdate-init: rewrite for beginners — explain dual-process architecture, lead with inline term explanations, progressive code examples (3-line first, full config second), table explains 'why' each required field exists. generalupdate-ui: rewrite for beginners — clarify Client vs Upgrade role, simplify to 4 key states, add console progress bar example. generalupdate-strategy: rewrite for beginners — explain strategy essence (3 questions), quick picker table, per-strategy use-case/flow/pros-cons layout. English i18n: sync all changes. Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR rewrites the Agent Skills documentation to be more newcomer-friendly for first-time GeneralUpdate users, aligning with Issue #128 by adding clearer concepts, progressive examples, and tool integration guidance.
Changes:
- Reworked Agent Skills overview pages to explain what a Skill is, list available skills, and document multi-assistant integration (Claude Code, GitHub Copilot, Cursor, etc.).
- Rewrote
generalupdate-init,generalupdate-ui, andgeneralupdate-strategydocs to focus on beginner mental models (dual-process roles, key UI states, strategy picker). - Synced equivalent rewrites into the English i18n docs.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/agent-skills/overview.md | Adds Skill concept explanation, new install options, and multi-assistant integration guidance. |
| website/docs/agent-skills/generalupdate-init.md | Rewritten beginner integration guide with dual-process explanation + progressive setup examples. |
| website/docs/agent-skills/generalupdate-ui.md | Simplifies UI guidance around Client/Upgrade roles and 4 key states, adds console example. |
| website/docs/agent-skills/generalupdate-strategy.md | Reframes strategy selection around a quick picker + simplified strategy explanations. |
| website/i18n/en/docusaurus-plugin-content-docs/current/agent-skills/overview.md | English sync of the overview rewrite and integration guidance. |
| website/i18n/en/docusaurus-plugin-content-docs/current/agent-skills/generalupdate-init.md | English sync of the rewritten integration guide. |
| website/i18n/en/docusaurus-plugin-content-docs/current/agent-skills/generalupdate-ui.md | English sync of the simplified UI guide and console example. |
| website/i18n/en/docusaurus-plugin-content-docs/current/agent-skills/generalupdate-strategy.md | English sync of the rewritten strategy guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
81
to
+85
| # Run in your project root | ||
| mkdir -p .claude/skills | ||
| cp -r <samples-path>/src/Hub/Samples/tmpgeneralupdate-skill-codegen/.claude/skills/* .claude/skills/ | ||
| cp <samples-path>/src/Hub/Samples/tmpgeneralupdate-skill-codegen/SKILL.md .claude/ | ||
| git clone https://github.com/GeneralLibrary/generalupdate-skill-codegen.git | ||
| cp -r generalupdate-skill-codegen/.claude/skills .claude/ | ||
| cp generalupdate-skill-codegen/SKILL.md .claude/ | ||
| rm -rf generalupdate-skill-codegen |
Comment on lines
+102
to
+105
| # Copy only the skill you need | ||
| git clone https://github.com/GeneralLibrary/generalupdate-skill-codegen.git /tmp/gussc | ||
| cp -r /tmp/gussc/.claude/skills/generalupdate-init .claude/skills/ | ||
| rm -rf /tmp/gussc |
Comment on lines
+132
to
+135
| Console.Write($"\rDownload progress: {e.ProgressPercentage}% "); | ||
| Console.Write($"[{new string('■', (int)(e.ProgressPercentage / 5))}"); | ||
| Console.WriteLine($"{new string('□', 20 - (int)(e.ProgressPercentage / 5))}]"); | ||
| Console.Write($"Speed: {e.Speed}/s"); |
Comment on lines
228
to
231
| await new GeneralUpdateBootstrap() | ||
| .AddListenerException((_, e) => | ||
| Console.WriteLine($"Error: {e.Message}")) | ||
| .LaunchAsync(); |
Comment on lines
81
to
+85
| # 在你的项目根目录下执行 | ||
| mkdir -p .claude/skills | ||
| cp -r <samples-path>/src/Hub/Samples/tmpgeneralupdate-skill-codegen/.claude/skills/* .claude/skills/ | ||
| cp <samples-path>/src/Hub/Samples/tmpgeneralupdate-skill-codegen/SKILL.md .claude/ | ||
| git clone https://github.com/GeneralLibrary/generalupdate-skill-codegen.git | ||
| cp -r generalupdate-skill-codegen/.claude/skills .claude/ | ||
| cp generalupdate-skill-codegen/SKILL.md .claude/ | ||
| rm -rf generalupdate-skill-codegen |
Comment on lines
+102
to
+105
| # 只复制你需要的 skill | ||
| git clone https://github.com/GeneralLibrary/generalupdate-skill-codegen.git /tmp/gussc | ||
| cp -r /tmp/gussc/.claude/skills/generalupdate-init .claude/skills/ | ||
| rm -rf /tmp/gussc |
Comment on lines
+133
to
+136
| Console.Write($"\r下载进度: {e.ProgressPercentage}% "); | ||
| Console.Write($"[{new string('■', (int)(e.ProgressPercentage / 5))}"); | ||
| Console.WriteLine($"{new string('□', 20 - (int)(e.ProgressPercentage / 5))}]"); | ||
| Console.Write($"速度: {e.Speed}/s"); |
Comment on lines
228
to
231
| await new GeneralUpdateBootstrap() | ||
| .AddListenerException((_, e) => | ||
| Console.WriteLine($"错误: {e.Message}")) | ||
| .LaunchAsync(); |
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.
概述
对所有 Agent Skills 文档页面做新手友好度优化，让第一次接触 GeneralUpdate 的开发者能快速理解和使用。
对应的 Issue：#128
修改清单
website/docs/agent-skills/overview.mdwebsite/docs/agent-skills/generalupdate-init.mdwebsite/docs/agent-skills/generalupdate-ui.mdwebsite/docs/agent-skills/generalupdate-strategy.md不做改动
generalupdate-advanced/troubleshoot/migration/security-audit面向前端已有经验的开发者，内容无需往新手方向调整。验证