update-llms

更新 LLMs.txt 文件

更新仓库根目录下现有的 llms.txt 文件，以反映文档、规范或仓库结构的变化。该文件为大模型（LLM）提供高层指引，说明在哪里可以找到理解仓库用途和规范的相关内容。

首要指令

更新现有的 llms.txt 文件，使其保持准确性并符合 llms.txt 规范，同时反映当前的仓库结构和内容。该文件必须继续针对 LLM 消费进行优化，同时保持人类可读。

分析与规划阶段

在更新 llms.txt 文件之前，你必须完成一次全面的分析：

步骤 1：审查当前文件和规范

• 阅读现有的 llms.txt 文件，了解当前结构
• 查阅 https://llmstxt.org/ 上的官方规范，确保持续合规
• 根据仓库变化，识别可能需要更新的部分

步骤 2：仓库结构分析

• 使用适当的工具检查当前的仓库结构
• 将当前结构与现有 llms.txt 中记录的内容进行对比
• 识别应纳入的新目录、文件或文档
• 记录任何已删除或已迁移、需要更新的文件

步骤 3：内容发现与变更检测

• 识别新的 README 文件及其位置
• 查找新的文档文件（/docs/、/spec/ 等目录中的 .md 文件）
• 定位新的规范文件及其用途
• 发现新的配置文件及其相关性
• 查找新的示例文件和代码示例
• 识别现有文档结构的任何变化

步骤 4：创建更新计划

根据你的分析，创建一个结构化计划，包括：

• 为保持准确性所需的更改
• 要添加到 llms.txt 的新文件
• 要删除或更新的过时引用
• 为保持清晰而进行的组织改进

实施要求

格式合规

更新后的 llms.txt 文件必须按照规范保持以下确切结构：

1. H1 标题：单行，包含仓库/项目名称（必需）
2. 引用块摘要：以引用块格式提供的简要描述（可选但推荐）
3. 附加详情：零个或多个不带标题的 markdown 章节，用于提供上下文
4. 文件列表章节：零个或多个包含 markdown 链接列表的 H2 章节

内容要求

必需元素

• 项目名称：作为 H1 的清晰、具有描述性的标题
• 摘要：简要说明仓库用途的引用块
• 关键文件：按类别组织的必要文件（H2 章节）

文件链接格式

每个文件链接必须遵循：[descriptive-name](relative-url): optional description

章节组织

将文件组织到逻辑清晰的 H2 章节中，例如：

• Documentation：核心文档文件
• Specifications：技术规范和需求
• Examples：示例代码和使用示例
• Configuration：设置和配置文件
• Optional：次要文件（特殊含义 - 可跳过以缩短上下文）

内容准则

语言与风格

• 使用简洁、清晰、明确的语言
• 避免使用未经解释的术语
• 同时面向人类和 LLM 读者编写
• 在描述中做到具体且信息丰富

文件选择标准

纳入以下文件：

• 说明仓库的用途和范围
• 提供必要的技术文档
• 展示使用示例和模式
• 定义接口和规范
• 包含配置和设置说明

排除以下文件：

• 纯粹是实现细节
• 包含冗余信息
• 是构建产物或生成内容
• 与理解项目无关

执行步骤

第 1 步：当前状态分析

1. 完整阅读现有的 llms.txt 文件
2. 全面检查当前的仓库结构
3. 将现有文件引用与实际仓库内容进行对比
4. 找出过时、缺失或错误的引用
5. 记录当前文件存在的任何结构问题

第 2 步：内容规划

1. 判断主要用途说明是否需要更新
2. 如有必要，审查并更新摘要块引用
3. 规划新增文件和目录的添加
4. 规划删除过时或已移动的内容
5. 如有必要，重新组织章节以提高清晰度

第 3 步：文件更新

1. 更新仓库根目录下的现有 llms.txt 文件
2. 保持符合确切的格式规范
3. 添加带有适当描述的新文件引用
4. 删除或更新过时的引用
5. 确保所有链接均为有效的相对路径

第 4 步：验证

1. 确认持续符合 https://llmstxt.org/ 规范
2. 检查所有链接是否有效且可访问
3. 确保该文件仍能作为有效的 LLM 导航工具
4. 确认该文件仍同时具备人类和机器可读性

质量保证

格式验证

• ✅ 包含项目名称的 H1 标题
• ✅ 块引用摘要（如包含）
• ✅ 用于文件列表的 H2 章节
• ✅ 正确的 markdown 链接格式
• ✅ 无失效或无效链接
• ✅ 全文格式一致

内容验证

• ✅ 清晰、无歧义的语言
• ✅ 全面覆盖关键文件
• ✅ 内容组织合乎逻辑
• ✅ 适当的文件描述
• ✅ 可作为有效的 LLM 导航工具

规范符合性

• ✅ 严格遵循 https://llmstxt.org/ 格式
• ✅ 使用要求的 markdown 结构
• ✅ 适当实现可选章节
• ✅ 文件位于仓库根目录（/llms.txt）

更新策略

添加流程

添加新内容时：

1. 确定新文件应归属的适当章节
2. 为链接创建清晰、具有描述性的名称
3. 编写简洁但信息丰富的描述
4. 在章节内保持字母顺序或逻辑顺序
5. 考虑是否需要为新内容类型新增章节

删除流程

删除过时内容时：

1. 确认文件确实已被删除或移动
2. 检查已移动的文件是否应当更新而非删除
3. 如果整个章节变为空，则删除该章节
4. 如有必要，更新交叉引用

重组流程

重构内容时：

1. 保持从一般到具体的逻辑流程
2. 将关键文档保留在主要章节中
3. 如适当，将次要内容移至“可选”章节
4. 确保新的组织结构能改善 LLM 导航

llms.txt 的示例结构：

# [Repository Name]

> [Concise description of the repository's purpose and scope]

[Optional additional context paragraphs without headings]

## Documentation

- [Main README](README.md): Primary project documentation and getting started guide
- [Contributing Guide](CONTRIBUTING.md): Guidelines for contributing to the project
- [Code of Conduct](CODE_OF_CONDUCT.md): Community guidelines and expectations

## Specifications

- [Technical Specification](spec/technical-spec.md): Detailed technical requirements and constraints
- [API Specification](spec/api-spec.md): Interface definitions and data contracts

## Examples

- [Basic Example](examples/basic-usage.md): Simple usage demonstration
- [Advanced Example](examples/advanced-usage.md): Complex implementation patterns

## Configuration

- [Setup Guide](docs/setup.md): Installation and configuration instructions
- [Deployment Guide](docs/deployment.md): Production deployment guidelines

## Optional

- [Architecture Documentation](docs/architecture.md): Detailed system architecture
- [Design Decisions](docs/decisions.md): Historical design decision records

成功标准

更新后的 llms.txt 文件应当：

1. 准确反映当前的仓库结构和内容
2. 保持符合 llms.txt 规范
3. 提供指向关键文档的清晰导航
4. 删除过时或错误的引用
5. 包含新的重要文件和文档
6. 保持逻辑组织以便于 LLM 使用
7. 全文使用清晰、无歧义的语言
8. 继续有效服务于人类和机器读者