update-docs

Audit and update documentation after code changes. Use when architecture, APIs, or behavior changed and docs may have drifted.

インストール方法

デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。

Codex または Claude でインストールこの Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。

直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。

npx skills add https://github.com/gitlabhq/orbit-knowledge-graph --skill update-docs

コマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。

ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。

インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。

SKILL.md

ソースの指示 · 読み取り専用プレビュー

name	update-docs
description	Audit and update documentation after code changes. Use when architecture, APIs, or behavior changed and docs may have drifted.
allowed-tools	Read, Edit, Write, Glob, Grep, Bash(mise ), Bash(npx ), Bash(git ), Bash(glab )

Docs rot when code moves faster than prose. After a code change, check if the docs still describe reality. Fix what drifted. Skip what didn't.

If agent teams are available, create an agent team for each major section of the documents.

README.md is the SSOT. Use /related-repositories for dependent repos.

Location	Contents
`README.md`	Epics, repositories, Helm charts, infra, people
`docs/design-documents/`	Architecture (indexing, querying, data model, security, observability)
`docs/dev/`	Local setup, infrastructure, runbook
`CLAUDE.md` / `AGENTS.md`	Agent context. Must stay identical — CI enforces this.
`crates/*/README.md`	Per-crate docs
`crates/indexer/AGENTS.md`	Indexer agent context
`skills/orbit/`	Agent skill for Knowledge Graph queries. `SKILL.md`, , are hand-written and need updates when API behavior or response shape changes. is byte-equal-synced from (CI-enforced via , no manual action needed).