Skip to content

docs: 插件开发教程和索引 Schema 移到 lithe-plugin-docs - #21

Merged
xiaoyumuxi merged 1 commit into
mainfrom
docs/move-plugin-guides
Oct 23, 2026
Merged

xiaoyumuxi merged 1 commit into
mainfrom
docs/move-plugin-guides

Conversation

@xiaoyumuxi

Copy link
Copy Markdown
Collaborator

背景

插件开发资料已经集中到新的公开仓库 Lithe-IDEA/lithe-plugin-docs(主仓库 1lck/Lithe-IDEA#1442 已合并):开发指南、教程、插件契约的完整副本和官方 SDK 都在那里。Lithe Store 只保留收录、发布和维护相关的文档。

改动

  1. 删除两篇教程:docs/lsp-plugin-lifecycle.md、docs/build-tool-integration.md 已搬到 lithe-plugin-docs 的 guides/,正文相同,只改写了链接。
  2. 删除 schema/plugin-index.schema.json:插件契约的副本在 lithe-plugin-docs 的 contract/v1/,本仓库不再保存 Schema 副本。
  3. Validate index 的契约检查(.github/workflows/validate.yml):
    • 原来:下载主仓库 preview 的 plugin-index.schema.json,与本仓库副本逐字比对。
    • 现在:下载 lithe-plugin-docs main 上的 plugin-index.schema.json,检查 SHA-256 是否等于工作流里记录的 SCHEMA_SHA256。不一致说明索引契约变了,CI 失败并提示按 docs/maintainers.md 跟进。404 仍只提示、其他 HTTP 错误仍只警告,和原来一样。
    • 记录的值 6771cb0e… 是 lithe-plugin-docs 当前 main 上的文件(契约锁定在 1lck/Lithe-IDEA@d37e4bf)。
    • 必须现在改:#1442 把 Schema 的 $id 改成了 lithe-plugin-docs 的地址,主仓库的 Schema 和本仓库副本不再相同,旧检查在下一次 push、PR 或每周定时运行时都会失败。
  4. 入口链接:README.md 顶部导航新增“📚 开发插件”,README、CONTRIBUTING.md、docs/publishing.md 里的教程和 Schema 链接改到 lithe-plugin-docs;CONTRIBUTING.md 的文档表和目录说明同步更新。
  5. docs/maintainers.md:“同步 Lithe 契约”改为“跟进插件契约变化”,步骤改为:对照 lithe-plugin-docs 的提交记录查看改了什么 → 更新 fixtures 和 validate-index.mjs → 运行测试 → 更新 SCHEMA_SHA256。
  6. scripts/store.test.mjs:只改注释里 fixtures 的来源。

不变

validate-index.mjs、scripts/fixtures/、lithe-plugin-index.json 都没有改,收录规则不变。

验证

  • SCHEMA_SHA256 与 lithe-plugin-docs main 上的文件、本地契约副本三者一致。
  • 删除的 Schema 副本与 lithe-plugin-docs 版本只差 $id 一行。
  • 新链接(两篇教程、Schema)都返回 200。
  • actionlint .github/workflows/validate.yml、git diff --check 通过。

两篇教程搬到 lithe-plugin-docs 的 guides/,删除 schema/plugin-index.schema.json 副本;
Validate index 改为核对 lithe-plugin-docs 上 plugin-index.schema.json 的 SHA-256,
README、CONTRIBUTING、发布与维护文档的链接同步更新。
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