docs: 実装との乖離修正バッチ(Bolt 1 divergence-fixes — 260805-docs-impl-sync) - #2302
Merged
Conversation
The framework ships fifteen scopes, not ten. Update the count words that sit next to an inline enumeration to the measured value and extend the enumeration with installer-distribution and the four self-* scopes; rewrite the prose count words that have no adjacent enumeration to a count-free form so they cannot go stale again. Drop the '37 runner descriptions' figure from the Codex CLI page for the same reason.
The sensor reference exemplified only four of the eight shipped manifests and pointed at the generated dist/ tree as their home. List every manifest in the matches and timeout tables, add the missing event-registry-drift row to the harness-engineering inventory, and repoint the authoring and example paths at the canonical packages/framework/core/sensors/ source (the compile resolver walks the installed .claude/sensors/ tree, so that reference stays runtime-side).
Add the Kimi Code and Pi Coding Agent badges, list pi/ in the harness and dist trees, add pi to the installer wizard roster, and enumerate all eight harnesses in the docs landing page. Correct the Kimi Code floor to 0.29.0 to match MIN_KIMI_VERSION, and resync the Japanese README version badge to 0.1.7.
…I reference The Quick Reference table omitted seven verbs that the utility CLI's own help output advertises. Transcribe them from that output.
The Japanese state-machine reference was missing the whole '### Loop monitor and quality repair' section, so five audit events had no Japanese counterpart. Port the heading, lead paragraph, and all five rows, keeping event names and emitter paths verbatim so the t48 forward check still matches. Scope declaration: the authorized change was the two events AUTO_DECISION_REVIEWED and INTENT_COMPLETION_TRANSACTION_COMMITTED. Porting only those two was not realizable because the containing section was absent entirely; election E-DIS-CG1 (choice 1, 2-0) authorized widening this to the whole section.
Same defect as the count words already fixed in the skills and scopes chapters: the architecture summary claimed ten named scopes next to an inline enumeration. Update to the measured fifteen and extend the enumeration with installer-distribution and the four self-* scopes.
|
Warning Review limit reached
Next review available in: 56 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (25)
📝 WalkthroughWalkthroughREADME、ガイド、技術リファレンスを更新しました。対応ハーネス、CLI コマンド、スキル、スコープ、センサー仕様、監査イベント分類の記述を現行仕様に同期しました。 Changesドキュメント仕様の同期
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guide/harnesses/codex-cli.ja.md`:
- Line 355: Update the Codex CLI guide examples at
docs/guide/harnesses/codex-cli.ja.md#L355-L355 and
docs/guide/harnesses/codex-cli.md#L363-L363 so the runner example uses a stage
runner such as $amadeus-code-generation instead of $amadeus-fix. Keep the
surrounding explanation intact, and make sure both localized guides stay
consistent with the scope-ranner classification used in
docs/guide/17-skills.ja.md and docs/guide/17-skills.md.
In `@docs/harness-engineering/04-scopes.ja.md`:
- Line 5: Update the Japanese scope documentation text in the scope-catalog
section so it no longer refers to an old “10 scopes” count; align the wording
with the current named-scope catalog described by the surrounding scope
narrative and the `docs/guide/17-skills.ja.md` reference. Use the existing
scope-catalog wording in this document (around the line mentioning scope
selection) and replace the outdated count with a neutral phrase like “all scopes
catalog” while preserving the rest of the explanation.
In `@docs/harness-engineering/06-sensors.ja.md`:
- Line 39: Update the document-shape sensor descriptions to include codekb in
the artifact-tree scope: in docs/harness-engineering/06-sensors.ja.md#L39-L39
and docs/harness-engineering/06-sensors.md#L77-L80, revise the matches glob and
surrounding scope text to include codekb alongside amadeus-docs and intents; in
docs/reference/07-sensor-system.ja.md#L199-L215 and
docs/reference/07-sensor-system.md#L202-L217, update the matches table and the
explanatory text so the listed artifact-tree glob matches the current manifest
value and no longer omits codekb.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: ad6364e9-1d4b-4ed7-9fbc-b310acc543c2
📒 Files selected for processing (19)
README.ja.mdREADME.mddocs/README.ja.mddocs/README.mddocs/guide/12-cli-commands.ja.mddocs/guide/12-cli-commands.mddocs/guide/17-skills.ja.mddocs/guide/17-skills.mddocs/guide/harnesses/codex-cli.ja.mddocs/guide/harnesses/codex-cli.mddocs/harness-engineering/04-scopes.ja.mddocs/harness-engineering/04-scopes.mddocs/harness-engineering/06-sensors.ja.mddocs/harness-engineering/06-sensors.mddocs/reference/01-architecture.ja.mddocs/reference/01-architecture.mddocs/reference/07-sensor-system.ja.mddocs/reference/07-sensor-system.mddocs/reference/12-state-machine.ja.md
| | `amadeus-self-scope-consistency.md` | Amadeus の自己スコープファイルとコンパイル済みグリッド | 自己開発専用: 5つのドッグフード用ハーネス間で4つの `self-*` スコープが一致すること | | ||
|
|
||
| そのすべてが `matches:` グロブ(詳細は下記)でゲートされます。最初の2つのドキュメント形状チェックは成果物ツリーにスコープし(同梱マニフェストは `**/{amadeus-docs,intents}/**` を持ちます — intent ごとのレコードツリーで、移行前のプロジェクト向けにレガシーの `amadeus-docs/` アームを残しています)、2つのコード品質チェックはそれぞれの言語グロブ(`**/*.{ts,js}`、`**/*.{ts,tsx}`)に、answer-evidence チェックは questions ファイル(`**/*-questions.md`)に、モデルチェックは比較対象の spec と実装のパスにスコープします。自己スコープチェックは通常のプロジェクトでは休止し、`self-*` スコープが存在するときだけ有効になります。自分のものを記述する前に、`amadeus-required-sections.md` を最初から最後まで読んでください — 同梱の中で最も小さく、フロントマターと散文本文という全体の形を示しています。 | ||
| そのすべてが `matches:` グロブ(詳細は下記)でゲートされます。最初の2つのドキュメント形状チェックは成果物ツリーにスコープし(同梱マニフェストは `**/{amadeus-docs,intents}/**` を持ちます — intent ごとのレコードツリーで、移行前のプロジェクト向けにレガシーの `amadeus-docs/` アームを残しています)、2つのコード品質チェックはそれぞれの言語グロブ(`**/*.{ts,js}`、`**/*.{ts,tsx}`)に、answer-evidence チェックは questions ファイル(`**/*-questions.md`)に、event-registry ドリフトチェックは比較対象のレジストリと監査ツールに、モデルチェックは比較対象の spec と実装のパスにスコープします。自己スコープチェックは通常のプロジェクトでは休止し、`self-*` スコープが存在するときだけ有効になります。自分のものを記述する前に、`amadeus-required-sections.md` を最初から最後まで読んでください — 同梱の中で最も小さく、フロントマターと散文本文という全体の形を示しています。 |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
codekb を artifact-tree glob に追加してください。
PR 目標の現行 manifest 値は **/{amadeus-docs,intents,codekb}/** です。現在の説明と表は codekb を除外しています。このままでは codekb/ への書き込みで document-shape センサーが発火しないと読者に誤って伝えます。
docs/harness-engineering/06-sensors.ja.md#L39-L39: glob と適用範囲の説明へcodekbを追加してください。docs/harness-engineering/06-sensors.md#L77-L80: glob と適用範囲の説明へcodekbを追加してください。docs/reference/07-sensor-system.ja.md#L199-L215:matches表と後続の説明を更新してください。docs/reference/07-sensor-system.md#L202-L217:matches表と後続の説明を更新してください。
📍 Affects 4 files
docs/harness-engineering/06-sensors.ja.md#L39-L39(this comment)docs/harness-engineering/06-sensors.md#L77-L80docs/reference/07-sensor-system.ja.md#L199-L215docs/reference/07-sensor-system.md#L202-L217
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/harness-engineering/06-sensors.ja.md` at line 39, Update the
document-shape sensor descriptions to include codekb in the artifact-tree scope:
in docs/harness-engineering/06-sensors.ja.md#L39-L39 and
docs/harness-engineering/06-sensors.md#L77-L80, revise the matches glob and
surrounding scope text to include codekb alongside amadeus-docs and intents; in
docs/reference/07-sensor-system.ja.md#L199-L215 and
docs/reference/07-sensor-system.md#L202-L217, update the matches table and the
explanatory text so the listed artifact-tree glob matches the current manifest
value and no longer omits codekb.
Member
Author
There was a problem hiding this comment.
ご指摘の codekb glob は把握済みですが、本 intent では構造的に修正できません: docs 側を現行値 **/{amadeus-docs,intents,codekb}/** へ直すと tests/unit/t174-docs-legacy-refs-gate.test.ts が tests/fixtures/docs-legacy-refs.json の逐語ピン(旧 glob)と両方向(unpinned-occurrence + stale-pin)で衝突して赤になります(builder が修正→赤を実測→revert 済み)。fixture は tests/ 配下で本 intent(self-document、実装コード変更禁止)の対象外のため、docs+fixture の同一 PR 是正を #2296 として起票済みです。
There was a problem hiding this comment.
@j5ik2o ご説明を確認しました。
指摘自体は有効です。
ただし、この PR の self-document スコープでは、tests/fixtures/docs-legacy-refs.json を同時に更新できません。文書だけを更新すると t174 の逐語ピンと衝突します。
#2296 で文書と fixture を同一変更として更新する方針は適切です。この PR では追加の変更を求めません。
✏️ Learnings added
Learnt from: j5ik2o
Repo: amadeus-dlc/amadeus PR: 2302
File: docs/harness-engineering/06-sensors.ja.md:39-39
Timestamp: 2026-08-05T16:21:23.118Z
Learning: In this repository, `tests/unit/t174-docs-legacy-refs-gate.test.ts` validates literal documentation references against pins in `tests/fixtures/docs-legacy-refs.json`. Updating a pinned documentation value, such as the artifact-tree glob `**/{amadeus-docs,intents,codekb}/**`, requires updating the corresponding fixture in the same change. A `self-document` intent can exclude changes under `tests/`; defer such coupled documentation-and-fixture corrections to a follow-up issue.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
You are interacting with an AI system.
…c) (#2306) * docs: document the self-* scopes and the installer-distribution scope The scope guide described ten scopes while the framework ships fifteen. Split the catalogue into the eleven general scopes and a dedicated section for the four self-development scopes, and add the previously undocumented installer-distribution scope. The new section explains what each self-* scope is for, why none of them is auto-detected, and why self-fix and self-refactor keep Comprehensive verification at Minimal depth. Depth, test strategy, and EXECUTE counts are transcribed from the compiled scope grid; the prose is derived from the scope files under packages/framework/core/scopes/. Extend the routing and test-strategy-default tables to all fifteen scopes, point the skills guide at the section from the scope-runner discussion, and cross-link it from the harness-engineering naming note. * docs: drop the stale scope count from the Japanese scopes chapter The Japanese chapter promised a catalogue of ten scopes while the framework ships fifteen, and its English counterpart was already count-free. Match the English wording so the sentence no longer has to be resynchronised whenever a scope is added.
…-impl-sync) (#2310) * docs: document the TLA+ authoring CLI and evidence store * docs: document the plugin import-closure guard * docs: add the Intent autonomy, review, and completion reference chapter * docs: document the advisory choice acceptance paths * docs: correct the packaged harness face count and roster for the pi face
The sentence introduces stage runners, but one of its two examples was $amadeus-fix — a scope runner. Swap it for $amadeus-code-generation so both examples match the runner kind the sentence describes. Addresses coderabbit review on #2302.
…-docs-impl-sync) (#2314) * docs: mark the upstream sync report as a frozen snapshot The report is a point-in-time investigation pinned to the revisions in its Compared revisions table. Readers reached it without any signal that it is not maintained, so state the freeze, point at the pinned revisions, and say it does not reflect current state. * docs: refresh the generated file inventory against the current tree The inventory was pinned to commit 9b77786 (2026-07) and had drifted: the hook, sensor and tools/data listings were short, otel/ and vendor/ were absent, .agents/ omitted rules/, the tools count was stale, and two stage outputs used retired artifact names (test-results rather than build-test-results and load-test-results). Re-measure from bun run dist and the produces: frontmatter, and index the page from docs/README. * docs: add the Japanese live harness end-to-end runbook The runbook was English-only while every other harness-engineering page ships a translation. Add the Japanese rendering and the language switch links the docs gate requires once the pair exists. The generated matrix block stays in the English page alone, since project-matrix.ts writes only that file and a duplicated block would drift silently. * docs: index the file inventory and live e2e runbook from the docs map Both pages were unreachable from the documentation map. Add one link line each, keeping the additions purely additive so parallel edits to this file do not conflict.
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.
概要
intent
260805-docs-impl-sync(scopeself-document)の Bolt 1 — docs と実装の乖離修正(FR-1 件数語 + FR-2 実体誤り)。RE 実測目録(observed1043b7e67、codekb/amadeus/re-scans/260805-docs-impl-sync.md)のクラス A(A-2〜A-9、A-11)・B(B-1〜B-3)・D(D-1〜D-4、D-7〜D-9)+ 同根 1 件(01-architecture のスコープ数)を是正。書込値はすべて編集直前の実測(basee6179d7c3)から転記。主な修正
MIN_KIMI_VERSION。旧記載どおりでは--doctorに拒否される)pi追加、docs/README の「4 ハーネス」→ 8dist/claude/.claude/sensors/参照 6 箇所を正本パスへ、JA 片側の「7つ」→ 8amadeus/spaces/default/elections/260805-e-dis-cg1/) の裁定 choice 1 に基づき節全体を忠実訳で移植した対象外(申告)
**/{amadeus-docs,intents}/**の旧値)— t174 fixture(tests/、本 intent 変更禁止面)がピンしているため documentation(sensor): docs のセンサー matches glob が codekb 拡張前の旧値のまま — t174 fixture ピンと同一 PR で是正する #2296 へ送付docs/guide/17-skills.mdの「(29 total)」— RE 独立検算で正(core 32 − init 3)と確定済みのため不変検証(ローカルを正とする — docs-only PR は CI の
changesjob でテスト層 skip、#2278 参照)bun test t174 t132 t68(unit)bun test t48 t52 t287 t291 t-pi-docs(integration)git statusRefs: #2276 #2277 #2278 #2296(いずれも本 intent の RE/CG で検出した構造因の別送 Issue — クローズ対象ではない)
Note
Low Risk
Changes are limited to markdown documentation with no runtime, installer, or test code touched; risk is stale or inconsistent docs remaining in files outside this batch (e.g. some pages still mention ten stock scopes).
Overview
Documentation-only pass aligning READMEs, guides, and reference chapters with reverse-engineered implementation facts (intent
260805-docs-impl-sync).Harness and install surfaces: English and Japanese READMEs add Kimi Code and Pi badges, list eight harnesses in the docs index, extend the install wizard harness list with
pi, and document Kimi Code ≥ 0.29.0 to matchMIN_KIMI_VERSION/--doctor. Repository layout diagrams include thepiharness anddist/tree.CLI and skills: Quick-reference tables in
12-cli-commandsgainintent,space,space-create,codekb-path, andpluginsubcommands.17-skillsdocuments utility skills (/amadeus-compose,/amadeus-election,/amadeus-upstream-sync) and revises scope catalog copy to 15 named scopes (includingself-*andinstaller-distribution).Scopes, sensors, architecture: Harness-engineering and architecture prose shifts from a fixed “ten scopes” framing to a catalog model and names 15 scopes where enumerated. Sensor docs list eight shipped manifests (adding
amadeus-event-registry-drift), expandmatchestables, and point canonical paths atpackages/framework/core/sensors/instead ofdist/claude/.claude/sensors/.i18n and misc: Japanese
12-state-machinegains the Loop monitor and quality repair section (events and emitters) aligned with English. Codex harness copy drops a hard “37 runners” count in favor of count-free wording.Reviewed by Cursor Bugbot for commit f088094. Configure here.
Summary by CodeRabbit
新機能
ドキュメント