Skip to content

docs(dsh-plugin): clarify installation, configuration, and releases - #196

Merged
iuyo5678 merged 3 commits into
mainfrom
codex/dsh-plugin-docs
Sep 8, 2026
Merged

iuyo5678 merged 3 commits into
mainfrom
codex/dsh-plugin-docs

Conversation

@iuyo5678

@iuyo5678 iuyo5678 commented Sep 8, 2026 •

Copy link
Copy Markdown
Collaborator

背景

DSH 插件 README 的安装入口、升级步骤和配置位置不够清晰,发布示例也包含旧版本号。本文档更新让用户能按顺序完成安装、使用和配置,并明确 npm README 随新版本发布更新。

改动

  • 前置安装和升级步骤,统一中英文说明,保留 update --latest,写清已安装插件不会自动更新及升级后需重启 profile。
  • 在插件 README 的 Configuration 节保留完整 YAML 示例,明确 profile 文件位置;使用 id: browserskill 覆盖已安装插件的配置,说明整个 config 对象的替换规则。
  • 补回 lazyTools 的工具延迟注册行为;开发文档补充重复调用和会话恢复时的行为。
  • 将内部观测协议和工具实现说明移至 docs/development.md,修正插件代为调用 bsk 的描述,保留动态 npm 版本徽章。
  • 发布说明统一为“先提交文档 → release.mjs 生成版本提交和标签 → 推送提交及标签”,移除写死的版本示例。

验证

以下为本地检查:

  • 插件构建、打包通过,包内 README 与最终源文件完全一致。
  • 使用本机 dsh 的解析和配置合成函数验证 README 中的 YAML,确认覆盖现有插件且不产生重复项,配置值与插件 schema 默认值一致。
  • 发布脚本 dry-run、Markdown 代码围栏和相对链接检查通过,中英文安装及升级命令一致。
  • 与 main 对比,最终差异仅包含 4 个 Markdown 文件,发布工作流完全一致。

范围与发布影响

本 PR 只改文档,运行时代码、依赖、版本号和发布流程保持不变。配置示例留在用户 README,内部接口说明迁至开发文档。

合并后仍需发布新版本,npm 页面才会更新。本次未发布 npm 包或创建发布标签。

@iuyo5678 iuyo5678 changed the title docs(dsh-plugin): clarify setup and verify npm publishing docs(dsh-plugin): clarify installation, configuration, and releases Sep 8, 2026
@iuyo5678
iuyo5678 merged commit 4450fbe into main Sep 8, 2026
5 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.

2 participants