Repository navigation
docs: 插件开发教程和索引 Schema 移到 lithe-plugin-docs - #21
Merged
Merged
Conversation
两篇教程搬到 lithe-plugin-docs 的 guides/,删除 schema/plugin-index.schema.json 副本; Validate index 改为核对 lithe-plugin-docs 上 plugin-index.schema.json 的 SHA-256, README、CONTRIBUTING、发布与维护文档的链接同步更新。
xiaoyumuxi
marked this pull request as ready for review
October 23, 2026 09:34
This was referenced Oct 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
插件开发资料已经集中到新的公开仓库 Lithe-IDEA/lithe-plugin-docs(主仓库 1lck/Lithe-IDEA#1442 已合并):开发指南、教程、插件契约的完整副本和官方 SDK 都在那里。Lithe Store 只保留收录、发布和维护相关的文档。
改动
docs/lsp-plugin-lifecycle.md、docs/build-tool-integration.md已搬到 lithe-plugin-docs 的guides/,正文相同,只改写了链接。schema/plugin-index.schema.json:插件契约的副本在 lithe-plugin-docs 的contract/v1/,本仓库不再保存 Schema 副本。Validate index的契约检查(.github/workflows/validate.yml):preview的plugin-index.schema.json,与本仓库副本逐字比对。main上的plugin-index.schema.json,检查 SHA-256 是否等于工作流里记录的SCHEMA_SHA256。不一致说明索引契约变了,CI 失败并提示按docs/maintainers.md跟进。404 仍只提示、其他 HTTP 错误仍只警告,和原来一样。6771cb0e…是 lithe-plugin-docs 当前main上的文件(契约锁定在1lck/Lithe-IDEA@d37e4bf)。$id改成了 lithe-plugin-docs 的地址,主仓库的 Schema 和本仓库副本不再相同,旧检查在下一次 push、PR 或每周定时运行时都会失败。README.md顶部导航新增“📚 开发插件”,README、CONTRIBUTING.md、docs/publishing.md里的教程和 Schema 链接改到 lithe-plugin-docs;CONTRIBUTING.md的文档表和目录说明同步更新。docs/maintainers.md:“同步 Lithe 契约”改为“跟进插件契约变化”,步骤改为:对照 lithe-plugin-docs 的提交记录查看改了什么 → 更新 fixtures 和validate-index.mjs→ 运行测试 → 更新SCHEMA_SHA256。scripts/store.test.mjs:只改注释里 fixtures 的来源。不变
validate-index.mjs、scripts/fixtures/、lithe-plugin-index.json都没有改,收录规则不变。验证
SCHEMA_SHA256与 lithe-plugin-docsmain上的文件、本地契约副本三者一致。$id一行。actionlint .github/workflows/validate.yml、git diff --check通过。