Skip to content

docs: README 补齐安装步骤,区分 Skill 本体与 DSH 插件层 - #7

Merged
Tespera merged 1 commit into
mainfrom
docs/readme-polish
Aug 21, 2026
Merged

docs: README 补齐安装步骤,区分 Skill 本体与 DSH 插件层#7
Tespera merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@Tespera

@Tespera Tespera commented Aug 21, 2026

Copy link
Copy Markdown
Member

问题

新用户卡在第一步。 原来的安装说明是:

1. 加载 Skill——把本仓库目录交给你的 AI Agent(例如 clone 到 ~/.claude/skills/ 或项目根目录)。

全文没有一条能复制粘贴的命令,用户得自己猜目录结构。

#4 合并后又多了一个问题:根目录出现了 src/lib/tsconfig.jsonpackage.json,只想用 Claude Skill 的人打开仓库会疑惑「我是不是还得编译一下」。README 没有任何地方说明这些可以忽略。

改了什么

改动 说明
安装步骤 给出可复制的 git clone 命令,并明确「不需要编译,也不需要预装依赖」
主题去向 补充生成的主题复制到哪(站点目录下 themes/,默认 ~/Documents/Gridea Pro/themes/),并提醒改动 customConfig 后需重启应用
目录结构 标注「以上是 Skill 本体」,并列出 DSH 插件封装的文件,明确标为可完全忽略
DSH 一节 从一句话扩成一节:谁需要、和 Skill 本体什么关系、用 Claude / Cursor 的话跳过即可
开发环境 说明 pip install 通常不必手动执行 —— scaffoldvalidate 是纯标准库,只有 render_test.py 需要 jinja2 且会自动安装
过时描述 SKILL.md 的说明去掉「5 步工作流 + 16 条关键规则」,实际是 6 步、规则按引擎分组不编号,带数字的描述必然烂掉
标点 散文对齐仓库全角惯例(SKILL.md 全角 44:0、references 39:1,README 原本是异类);prompt 示例代码块内保持原样,避免无谓噪音

核对过的事实

  • git clone 地址:git ls-remote 验证有效
  • ~/Documents/Gridea Pro/ 是 Gridea Pro 的默认站点目录,本机存在;customConfig 的进程级缓存行为出自 SKILL.md 第 6 步
  • 「6 步」:SKILL.md 实有第 1–6 步,第 6 步为「真实引擎验证」
  • jinja2 依赖范围:scaffold_theme.py / validate_syntax.py 仅 import 标准库;render_test.py:305ImportError 时自动 pip 安装

不在本 PR 范围

  • 顶部缺一张生成结果的截图 —— 这是这份 README 最大的缺口(assets/ 下零张图片),但需要在 Gridea Pro 里实际预览截图,单独排
  • 「搭配前端设计 Skill」章节的位置偏靠前,暂未调整,避免和本次改动混在一起

🤖 Generated with Claude Code

新用户此前卡在第一步——原文只说「把仓库目录交给你的 AI Agent」,
没有一条可复制的命令;PR #4 之后根目录多了一层 TS 构建产物,
只用 Skill 的人也无从判断哪些文件可以忽略。

- 「怎么用」第 1 步给出 git clone 命令,并说明无需编译和预装依赖
- 补充生成的主题往哪放(站点目录 themes/,附 customConfig 需重启才生效的提醒)
- 目录结构标注 Skill 本体 vs DSH 插件封装,后者明确标为可忽略
- DSH 一句话扩成一节,讲清谁需要、谁可以跳过
- 开发环境说明 jinja2 只有 render_test 需要,且会自动安装
- SKILL.md 描述去掉会过时的「5 步 + 16 条」(实为 6 步,规则按引擎分组)
- 散文标点对齐仓库全角惯例(prompt 示例代码块内保持原样)

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Tespera
Tespera merged commit 987eeea into main Aug 21, 2026
4 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