Skip to content

docs: 优化 SKILL.md description,新增一句话安装指南,README 升级#5

Open
darkLordIceCream wants to merge 1 commit into
read2017:mainfrom
darkLordIceCream:pr-to-upstream
Open

docs: 优化 SKILL.md description,新增一句话安装指南,README 升级#5
darkLordIceCream wants to merge 1 commit into
read2017:mainfrom
darkLordIceCream:pr-to-upstream

Conversation

@darkLordIceCream

Copy link
Copy Markdown

这个 PR 做了什么

1. SKILL.md description 压缩(~300 → ~200 字符)

关键词前置(学习新知识、制定计划、项目陪练、掌握度检查),避免 OpenCode 等平台的 skill 列表预算截断。所有原始语义保留。

2. 新增 docs/guide/installation.md:AI Agent 可读的安装指南

  • 平台检测(OpenCode / Claude Code / Codex)
  • 用 curl 下载 skill 文件并验证
  • 设计为「一句话安装」模式:用户复制一句话给 Agent,Agent 自己读指南并安装

3. README 颜值升级

  • shields.io 徽章、emoji 分区、折叠案例
  • 所有原有安装内容完整保留
  • OpenCode 安装说明更新:从「只支持 command」改为「原生支持 SKILL.md」

4. .gitignore 追加 .opencode/sessions/

如果你觉得 README 改动太多,可以只合并前 3 个文件,README 不改也没问题。

…nize README

- SKILL.md: compress description from ~300 to ~200 chars, front-load trigger keywords (benefits all platforms by avoiding skill listing budget truncation)
- New docs/guide/installation.md: AI-agent-readable install guide with platform detection, curl-based download, and verification steps
- README.md / README.en.md: add shields.io badges, emoji sections, collapsible use cases, one-line install, update OpenCode section to reflect native skill support
- .gitignore: add .opencode/sessions/
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