Back to Details

update-refs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Update References

更新引用

Ensure naming and documentation consistency across all codebase locations.
确保代码库所有位置的命名与文档一致性。

Checklist

检查清单

When updating terminology, feature names, descriptions, or counts, check ALL locations:
在更新术语、功能名称、描述或数量时，需检查所有以下位置：

1. User-Facing Messages

1. 用户可见消息

LocationWhat to Check
launcher/banner.py
Welcome banner text, feature descriptions
launcher/cli.py
Pilot CLI help text and messages
installer/cli.py
Installer CLI help text, prompts
installer/steps/finalize.py
Post-install instructions
installer/ui.py
UI banner and status messages
位置检查内容
launcher/banner.py
欢迎横幅文本、功能描述
launcher/cli.py
Pilot CLI帮助文本与提示消息
installer/cli.py
安装器CLI帮助文本、提示信息
installer/steps/finalize.py
安装后说明文档
installer/ui.py
UI横幅与状态消息

2. Documentation & Website

2. 文档与网站

LocationWhat to Check
README.md
Feature descriptions, usage examples, counts (rules, hooks, skills, commands)
docs/site/index.html
SEO meta tags, page title, structured data
docs/site/src/pages/Index.tsx
SEO description, structured data counts
docs/site/src/components/HeroSection.tsx
Stats bar counts (rules, hooks, skills, LSPs, MCP)
docs/site/src/components/WhatsInside.tsx
Feature cards, descriptions, item counts
docs/site/src/components/DeepDiveSection.tsx
Under the Hood subtitle counts, hooks pipeline, rules categories
docs/site/src/components/WorkflowSteps.tsx
/spec workflow details, All Commands grid
docs/site/src/components/ComparisonSection.tsx
Before & After comparison table
docs/site/src/components/PricingSection.tsx
Standard plan feature counts, value proposition
docs/site/src/components/InstallSection.tsx
Installation instructions
docs/site/src/components/Footer.tsx
Footer links
docs/site/src/components/NavBar.tsx
Navigation links
位置检查内容
README.md
功能描述、使用示例、数量统计（规则、钩子、Skill、命令）
docs/site/index.html
SEO元标签、页面标题、结构化数据
docs/site/src/pages/Index.tsx
SEO描述、结构化数据统计
docs/site/src/components/HeroSection.tsx
统计栏数据（规则、钩子、Skill、LSP、MCP）
docs/site/src/components/WhatsInside.tsx
功能卡片、描述、项目数量
docs/site/src/components/DeepDiveSection.tsx
底层原理副标题统计、钩子流水线、规则分类
docs/site/src/components/WorkflowSteps.tsx
/spec工作流详情、全命令网格
docs/site/src/components/ComparisonSection.tsx
前后对比表格
docs/site/src/components/PricingSection.tsx
标准版功能数量、价值主张
docs/site/src/components/InstallSection.tsx
安装说明
docs/site/src/components/Footer.tsx
页脚链接
docs/site/src/components/NavBar.tsx
导航链接

3. Package & Install

3. 包与安装

LocationWhat to Check
pyproject.toml
Package name, description, metadata
install.sh
Shell installer script messages
launcher/__init__.py
Package docstring
位置检查内容
pyproject.toml
包名称、描述、元数据
install.sh
Shell安装脚本消息
launcher/__init__.py
包文档字符串

4. Claude Configuration (Plugin Source)

4. Claude配置（插件源）

LocationWhat to Check
pilot/commands/*.md
Command descriptions in frontmatter (
spec
, 
sync
, 
vault
, 
learn
, plus internal phases)
pilot/skills/*/SKILL.md
Skill descriptions in frontmatter
pilot/rules/*.md
Standard rules content
pilot/hooks/hooks.json
Hook configuration and event triggers
pilot/hooks/*.py
Hook script messages and logic
pilot/agents/*.md
Sub-agent definitions (plan-verifier, spec-verifier)
pilot/settings.json
LSP server configuration
pilot/modes/*.json
Language mode definitions
位置检查内容
pilot/commands/*.md
命令描述前置内容（
spec
、
sync
、
vault
、
learn
及内部阶段）
pilot/skills/*/SKILL.md
Skill描述前置内容
pilot/rules/*.md
标准规则内容
pilot/hooks/hooks.json
钩子配置与事件触发器
pilot/hooks/*.py
钩子脚本消息与逻辑
pilot/agents/*.md
子Agent定义（plan-verifier、spec-verifier）
pilot/settings.json
LSP服务器配置
pilot/modes/*.json
语言模式定义

5. Project-Level Claude Config

5. 项目级Claude配置

LocationWhat to Check
.claude/rules/*.md
Project-specific rules (git-commits.md, project.md)
.claude/skills/*/SKILL.md
Project-specific skills (lsp-cleaner, pr-review, update-refs)
位置检查内容
.claude/rules/*.md
项目特定规则（git-commits.md、project.md）
.claude/skills/*/SKILL.md
项目特定Skill（lsp-cleaner、pr-review、update-refs）

No Hardcoded Counts

禁止硬编码数量

Do NOT add specific counts (e.g., "22 rules", "7 hooks", "14 skills") to user-facing text.
The project deliberately avoids quantity-focused messaging. Use qualitative descriptions instead:
❌ Don't✅ Do
"22 rules loaded every session""Production-tested rules loaded every session"
"7 hooks auto-lint on every edit""Hooks auto-lint, format, type-check on every edit"
"14 coding skills""Coding skills activated dynamically"
"5 MCP servers + 3 LSP servers""MCP servers + language servers pre-configured"
"2,900+ lines of best practices""Production-tested best practices"
Why: Quality over quantity. Counts become stale and create maintenance burden across many files. The value is in what the system does, not how many components it has.
请勿在用户可见文本中添加具体数量（如“22条规则”、“7个钩子”、“14个Skill”）。
本项目刻意避免以数量为导向的表述，应改用定性描述：
❌ 错误示例✅ 正确示例
“每次会话加载22条规则”“每次会话加载经过生产环境验证的规则”
“7个钩子在每次编辑时自动 lint”“钩子在每次编辑时自动lint、格式化、类型检查”
“14个编码Skill”“编码Skill动态激活”
“5个MCP服务器 + 3个LSP服务器”“预配置MCP服务器 + 语言服务器”
“2900+行最佳实践”“经过生产环境验证的最佳实践”
原因： 质量优先于数量。具体数量会随时间过时，并增加多文件维护负担。系统的价值在于其功能，而非组件数量。

Workflow

工作流

  1. Search first - Use Grep to find all occurrences:
    Grep pattern="old term" glob="*.{md,py,tsx,json,ts}"
  2. Update systematically - Work through checklist above, section by section
  3. Verify consistency - Search again to confirm no misses:
    Grep pattern="old term" glob="*.{md,py,tsx,json,ts}"
  4. Build website - Verify site compiles after changes:
    bash
    cd docs/site && npm run build
  1. 先搜索 - 使用Grep查找所有匹配项：
    Grep pattern="旧术语" glob="*.{md,py,tsx,json,ts}"
  2. 系统化更新 - 按上述清单逐部分处理
  3. 验证一致性 - 再次搜索确认无遗漏：
    Grep pattern="旧术语" glob="*.{md,py,tsx,json,ts}"
  4. 构建网站 - 修改后验证站点可正常编译：
    bash
    cd docs/site && npm run build

Common Updates

常见更新场景

Change TypeKey Locations
Command rename/addpilot/commands/*.md, README.md, WorkflowSteps.tsx, WhatsInside.tsx, counts table
Skill renamepilot/skills/*/SKILL.md, README.md, WhatsInside.tsx, DeepDiveSection.tsx
Rule add/removepilot/rules/*.md, README.md, all count locations (see table above)
Hook changepilot/hooks/hooks.json, pilot/hooks/*.py, DeepDiveSection.tsx, README.md
Feature descriptionlauncher/banner.py, README.md, site components, Index.tsx structured data
Workflow changepilot/commands/.md, pilot/rules/.md, README.md, WorkflowSteps.tsx
Package renamepyproject.toml, install.sh, launcher/init.py, README.md
Installer messageinstaller/.py, installer/steps/.py
Terminology changeSearch all locations in checklist above — grep for old term, replace everywhere
变更类型关键位置
命令重命名/新增pilot/commands/*.md、README.md、WorkflowSteps.tsx、WhatsInside.tsx、统计表格
Skill重命名pilot/skills/*/SKILL.md、README.md、WhatsInside.tsx、DeepDiveSection.tsx
规则新增/移除pilot/rules/*.md、README.md、所有统计位置（见上表）
钩子变更pilot/hooks/hooks.json、pilot/hooks/*.py、DeepDiveSection.tsx、README.md
功能描述更新launcher/banner.py、README.md、站点组件、Index.tsx结构化数据
工作流变更pilot/commands/.md、pilot/rules/.md、README.md、WorkflowSteps.tsx
包重命名pyproject.toml、install.sh、launcher/init.py、README.md
安装器消息更新installer/.py、installer/steps/.py
术语变更搜索清单中所有位置 —— 用grep查找旧术语并全局替换