菜单
Documentation file naming for the Metaboost repo. Use when creating or modifying docs, README, or markdown.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Canonical linear DB migrations under infra/k8s/base/ops/source/database/linear-migrations, ops bundles, env keys, and runners. Use when adding or changing SQL migrations, K8s DB bootstrap, or scripts/database in this repo.
When an E2E test verifies a specific element, pass it to the capture helper so the step screenshot is taken with that element vertically centered.
Create and use Metaboost git worktrees in sibling directories named metaboost_<branch_slug> (underscores). Use when starting feature work, moving WIP off the main checkout, or opening the correct worktree path for a branch.
Distributed tracing and OTLP export patterns. Use when adding trace context, log correlation, or Observability env — after Metaboost adopts a shared observability package.
When you finish a plan file in active/, automatically move it to completed/. If it's the last plan in its set, move the whole set. Use when completing any plan under .llm/plans/active/.
User vocabulary abcmemory and abcremember — where Cursor guidance lives and how to persist new instructions. Use when the user says abcmemory or abcremember.
| name | metaboost-documentation-conventions |
| description | Documentation file naming for the Metaboost repo. Use when creating or modifying docs, README, or markdown. |
| version | 1.1.0 |
README.md at repository root.README.md). Subdirectories must use descriptive names (e.g. scripts/github/SCRIPTS-GITHUB.md, not README.md).Name after the full path from root (uppercase, slashes → hyphens):
apps/api/ → APPS-API.mdapps/web/ → APPS-WEB.mdinfra/k8s/ → INFRA-K8S.mdpackages/ui/ → PACKAGES-UI.mdscripts/github/ → SCRIPTS-GITHUB.md.llm/ → LLM.mdPattern: [FULL-PATH-WITH-HYPHENS].md. Do not add multiple README.md files per directory.
INDEX.md in the repo is .cursor/skills/INDEX.md (skills quick reference). All other directory overviews use the full-path name (e.g. INFRA-K8S.md, PACKAGES-UI.md)..llm/plans/ use 00-overview.md or 00-master-plan.md, not INDEX.md or README.md.When linking to a file outside the current documentation subtree, use a repo-root path
with a leading / (GitHub resolves these from the repository root):
✅ Cross-tree:
[api skill](/.cursor/skills/api/SKILL.md)
[QUICK-START](/docs/QUICK-START.md)
✅ Same subtree (e.g. both under docs/):
[ENV-REFERENCE](development/env/ENV-REFERENCE.md)
❌ Deep parent-relative chains:
`../../../../../.cursor/skills/api/SKILL.md`
/Users/...).../../../ (or longer) for cross-tree targets; use /path/from/repo/root instead./docs/FOO.md#section.