Skip to content

docs: Chinese-first README, and correct the style count - #19

Merged
AnxForever merged 2 commits into
mainfrom
docs/bilingual-readme
Sep 17, 2026
Merged

AnxForever merged 2 commits into
mainfrom
docs/bilingual-readme

Conversation

@AnxForever

@AnxForever AnxForever commented Sep 17, 2026 •

Copy link
Copy Markdown
Owner

仓库原本没有 README,SKILL.md 里的风格数也停在 146(实际 148)。

改动

1. 补齐 README(中文默认 + 英文)

  • README.md 中文,README.en.md 英文
  • 说明这个 Skill 做什么、五步工作流、四种任务分流
  • 列出五个脚本,点明 eval-check.py(验收检测器)和 benchmark.py(有无 skill 的对照)是这套设计的重点

2. 修正过时的风格数

  • SKILL.md 与 scripts/verify-spec.py 写的是 146,实际 148
  • 影响:让 agent「检查所有风格」时会静默漏掉两个
  • 已对照 stylekit 仓库的 registry 确认:148

验证

  • grep -rn 146 已无残留
  • README 中的 issue/PR 链接与相关仓库链接均为公开可访问

Summary by CodeRabbit

  • Documentation
    • Added comprehensive English documentation for StyleKit, including its workflow, style selection, task routing, installation, scripts, references, related projects, and licensing.
    • Updated StyleKit documentation to reflect support for 148 curated visual styles.
    • Updated verification guidance to indicate that all 148 styles are checked when no specific style is selected.

The catalog has held 148 styles for a while; the skill and the
verifier's usage text still said 146, so an agent told to check
'every style' would silently skip two.
The repository had no README at all, so the Skill's purpose, workflow
and scripts were only discoverable by reading SKILL.md.
@coderabbitai

coderabbitai Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 5d8e0c66-b3c1-452c-9455-c3f65ba756e6

📥 Commits

Reviewing files that changed from the base of the PR and between a9601b9 and 7466d83.

📒 Files selected for processing (4)
  • README.en.md
  • README.md
  • SKILL.md
  • scripts/verify-spec.py

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The change adds English and default README documentation for stylekit-skill. It also updates two existing descriptions from 146 to 148 curated styles.

Changes

Documentation and style count

Layer / File(s) Summary
Repository documentation
README.md, README.en.md
Adds documentation for the skill workflow, task routing, scripts, references, installation, related projects, and MIT license.
Style count consistency
SKILL.md, scripts/verify-spec.py
Updates the documented StyleKit count from 146 to 148.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 7466d

This PR adds bilingual documentation and corrects the published style count without introducing a merge-blocking product or runtime risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes both main changes: adding a Chinese-first README and correcting the published style count.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AnxForever
AnxForever merged commit c2f7c32 into main Sep 17, 2026
2 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.

1 participant