docs: position skill-up as an evaluation and evolution tool#155
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s top-level documentation and docs homepages to position skill-up as both an evaluation and evolution tool for Agent Skills, emphasizing an iterative loop driven by skill-upper (evaluate → diagnose → fix/expand evals → rerun).
Changes:
- Rewrites the English and Chinese READMEs to foreground the evaluation→evolution workflow and a skill-upper-led conversational Quick Start.
- Adds a shared “infinity loop” overview diagram reference (
docs/public/skill-up-overview.png) to the READMEs and docs homepages. - Updates VitePress homepages (EN/ZH) hero and feature copy to match the new positioning and adds an “Overview / 工作原理” section.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Repositions skill-up as evaluation + evolution; updates Quick Start to a skill-upper conversation flow and links to docs for manual setup. |
| README.zh.md | Mirrors the EN README updates in Chinese, including the evolution loop framing and revised Quick Start. |
| docs/index.md | Updates docs homepage hero/features and adds an “Overview” section referencing the shared diagram. |
| docs/zh/index.md | Updates the Chinese docs homepage hero/features and adds a “工作原理” section referencing the shared diagram. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 36e380f0c4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Summary
Why
The previous documentation presented skill-up primarily as an evaluation CLI and led with manual YAML setup. This update clarifies the broader eval-to-evolution workflow and makes the conversational skill-upper path the primary onboarding experience.
Impact
Documentation and image assets only; runtime behavior is unchanged.
Validation
npm run docs:buildmake verifymake test