Conversation
docs/ 与 docs-en/ 迁到 VelaShellLabs/velashell-docs 的 zh/templates 与 en/templates —— 面向插件作者的主文档(dev-guide、publishing)也在其中, 与 CLI 手册、SDK 参考、插件系统蓝图并排,不再靠 GitHub 绝对 URL 互指。 VelaBuildPackageVersion 的五处落点里有两处是 dev-guide.md 的 PackageReference 片段,它们跟着搬到了另一个仓库,而发版 runner 的 checkout 里没有它,原来的 `throw "落点文件不存在"` 会让 release 流水线 一上来就红。改成:那两处标 Repo = "docs",按 -DocsRoot / $env:VELASHELL_DOCS / 同级 ../velashell-docs 依次找,找不到就跳过并 Write-Warning 说明。本地两个仓库并排放着时,五处照旧一次改齐。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JXDSZWeBqsj4Uqgn4c9jHG
docs: 文档搬到 velashell-docs，Set-Version 的文档落点改成可选
本仓库此前没有任何给 AI 代理与新加入者看的操作约定文件,结果是两件事反复发生:
不读既有设计就动手,做出与蓝图冲突或重复实现的东西;改了代码不改文档,让文档开始骗人。
AGENTS.md 分三节。前两节九个仓库逐字相同,是生态级的约定:
一、开工前必读 velashell-docs —— 按分区列出该读哪几篇(host / plugins / sdk / cli /
templates),并说明为什么跳过这一步的代价。
二、涉及文档的改动一律同步到 velashell-docs —— 本仓库不新建文档目录;代码改动导致
行为/接口/配置/流程与文档不符时,必须同时提 velashell-docs 的 PR,两个 PR 互相
引用一起合;zh/ 与 en/ 互为镜像要一起改;文档内部一律相对链接。
第三节是本仓库自己的:构建与测试命令、真实存在的坑、哪几份文档刻意留在代码仓库
(以及为什么留),以及改什么代码要回写哪一篇文档。不是模板复制。
AGENTS.md 里引用的每一条 velashell-docs 路径都核对过存在。
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JXDSZWeBqsj4Uqgn4c9jHG
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
1 participant
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.
新增
AGENTS.md,把两条约定写死在仓库里,给 AI 代理与新加入者看:zh/与en/互为镜像要一起改;文档内部一律相对链接。前两节九个仓库逐字相同(生态级约定,不该各写各的)。第三节是本仓库自己的:构建与测试命令、真实存在的坑、哪几份文档刻意留在代码仓库以及为什么、改什么代码要回写哪一篇文档。不是模板复制。
AGENTS.md 里引用的每一条 velashell-docs 路径都核对过存在。
🤖 Generated with Claude Code
https://claude.ai/code/session_01JXDSZWeBqsj4Uqgn4c9jHG