Skip to content

docs: position skill-up as an evaluation and evolution tool#155

Merged
hittyt merged 3 commits into
mainfrom
agent/docs-evaluation-evolution
Jul 24, 2026
Merged

docs: position skill-up as an evaluation and evolution tool#155
hittyt merged 3 commits into
mainfrom
agent/docs-evaluation-evolution

Conversation

@jwx0925

@jwx0925 jwx0925 commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • position skill-up as an evaluation and evolution tool for Agent Skills across the English and Chinese READMEs and documentation homepages
  • add a shared infinity-loop overview diagram that connects evaluation results to skill-upper-driven fixes, regression coverage, and reruns
  • rewrite Quick Start around the recommended skill-upper conversation flow for creating evals, fixing the Skill or eval suite, and iterating
  • keep manual CLI setup concise and link readers to the official documentation

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:build
  • make verify
  • make test

@jwx0925
jwx0925 marked this pull request as ready for review July 24, 2026 06:51
@jwx0925
jwx0925 requested a review from hittyt as a code owner July 24, 2026 06:51
@roark47
roark47 requested review from Copilot and roark47 July 24, 2026 06:59

@roark47 roark47 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/index.md Outdated
Comment thread docs/zh/index.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread skills/skill-upper/SKILL.md
Comment thread skills/skill-upper/evals/cases/evolve-existing-skill.yaml
Comment thread skills/skill-upper/SKILL.md
@jwx0925
jwx0925 enabled auto-merge July 24, 2026 07:46

@hittyt hittyt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hittyt
hittyt disabled auto-merge July 24, 2026 10:40
@hittyt
hittyt merged commit 148bd86 into main Jul 24, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants