Merged
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Caution Review failedPull request was closed or merged during review Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds many new command-reference documentation pages across Code Review, Codebase, Spec, and Govern bundles; updates bundle overviews to link to those deep dives; and introduces tests, an OpenSpec, TDD evidence, and completed task entries validating the new docs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related issues
Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
djm81
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/bundles/code-review/run.md`:
- Line 22: The table row containing the option string `--scope changed|full` is
being parsed as extra Markdown columns; update the cell value for the `--scope
changed|full` entry (the exact token `--scope changed|full`) so the pipe is
escaped (e.g., `\|`) within the code span or otherwise escape the pipe character
in that table cell to restore valid table rendering.
In `@docs/bundles/codebase/drift.md`:
- Line 23: The table cell containing the option literal --format
<table|json|yaml> uses raw pipe characters which break the Markdown table;
update that cell to escape the pipes (e.g., replace | with \| or HTML entity
|) so the literal remains a single cell; locate the occurrence of the
--format option in drift.md and apply the escaping to the <table|json|yaml>
part.
In `@docs/bundles/govern/enforce.md`:
- Around line 25-42: Table cells contain raw pipe characters inside option
literals like `--preset <minimal|balanced|strict>` and `--output-format
<yaml|json|markdown>` which can break Markdown tables; update these literals to
escape the pipes (e.g., change `|` to `\|` inside the backticks) so they render
as a single cell (e.g., `--preset <minimal\|balanced\|strict>` and
`--output-format <yaml\|json\|markdown>`), leaving surrounding text and examples
unchanged.
In `@docs/bundles/spec/generate-tests.md`:
- Around line 12-17: overview.md incorrectly documents commands under a
non-existent "specfact spec api" subgroup; update docs/bundles/spec/overview.md
to list the commands (validate, backward-compat, generate-tests, mock) directly
under "specfact spec" to match the actual CLI registration (e.g., the correct
command shown in generate-tests.md is "specfact spec generate-tests"); remove
the "api" subgroup heading/mentions and ensure each command entry uses the
"specfact spec <command>" form so the docs align with the code.
In `@docs/bundles/spec/mock.md`:
- Around line 12-17: The docs show a mismatch: the spec overview documents
commands under the "specfact spec api" subgroup but the implementation/registers
the command as "specfact spec mock" (the identity strings 'specfact spec mock'
and 'specfact spec api' appear in the diff); fix by making them
consistent—either update the CLI registration to register the mock commands
under the "api" subgroup (rename the command registration from 'spec mock' to
'spec api mock' or add an alias) or update the documentation to reference
'specfact spec mock' everywhere; ensure you change all occurrences of the
command string used in the command registry (the code that defines the command
name/aliases) and the docs (the spec overview text) so both match exactly.
In `@docs/bundles/spec/validate.md`:
- Around line 57-59: The relative links on the validate.md page point to
subpaths under /bundles/spec/validate/ instead of the intended /bundles/spec/;
update each link (the "Spec bundle overview", "Generate Specmatic tests", and
"Run a mock server" list items) to use parent-relative paths (e.g. ../overview/,
../generate-tests/, ../mock/) or absolute paths (e.g. /bundles/spec/overview/)
so they resolve correctly from the page permalink /bundles/spec/validate/.
In `@openspec/specs/missing-command-docs/spec.md`:
- Around line 1-31: The markdown headings (e.g., "## ADDED Requirements", "###
Requirement: Missing command reference pages SHALL document the implemented
command surface", and each "#### Scenario:" heading) need a blank line
immediately after them to follow project markdown conventions; update spec.md so
there is an empty line after each heading line (including the top-level "##",
the "### Requirement:" block header, and every "#### Scenario:" header) so that
subsequent paragraph text or list items start on their own paragraph lines and
the lists render correctly.
🪄 Autofix (Beta)
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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 7858d74d-1432-437d-99fa-3548a8842b8c
📒 Files selected for processing (19)
docs/bundles/code-review/ledger.mddocs/bundles/code-review/overview.mddocs/bundles/code-review/rules.mddocs/bundles/code-review/run.mddocs/bundles/codebase/analyze.mddocs/bundles/codebase/drift.mddocs/bundles/codebase/overview.mddocs/bundles/codebase/repro.mddocs/bundles/govern/enforce.mddocs/bundles/govern/overview.mddocs/bundles/govern/patch.mddocs/bundles/spec/generate-tests.mddocs/bundles/spec/mock.mddocs/bundles/spec/overview.mddocs/bundles/spec/validate.mdopenspec/changes/docs-09-missing-command-docs/TDD_EVIDENCE.mdopenspec/changes/docs-09-missing-command-docs/tasks.mdopenspec/specs/missing-command-docs/spec.mdtests/unit/docs/test_missing_command_docs.py
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
docs/bundles/govern/enforce.md (1)
60-61:⚠️ Potential issue | 🟠 MajorRelated links are path-broken from this page URL.
On Line 60 and Line 61, these relative links are nested under
/bundles/govern/enforce/. They should target sibling pages under/bundles/govern/.🔗 Proposed fix
-- [Govern patch](patch/) -- [Govern bundle overview](overview/) +- [Govern patch](/bundles/govern/patch/) +- [Govern bundle overview](/bundles/govern/overview/)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/bundles/govern/enforce.md` around lines 60 - 61, The two relative links "[Govern patch](patch/)" and "[Govern bundle overview](overview/)" are resolving under /bundles/govern/enforce/ and should point to sibling pages under /bundles/govern/; update those link targets to reference the sibling paths (for example change to "../patch/" and "../overview/" or absolute "/bundles/govern/patch/" and "/bundles/govern/overview/") so they resolve correctly from the enforce page.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/bundles/code-review/run.md`:
- Around line 49-51: Update the child-relative links "ledger/" and "rules/" so
they point to the sibling pages under the code-review bundle (use
parent-relative "../ledger/" and "../rules/" or absolute
"/bundles/code-review/ledger/" and "/bundles/code-review/rules/"); modify the
link targets in the document where "ledger/" and "rules/" appear and leave the
existing "../../modules/code-review/" link unchanged.
In `@docs/bundles/codebase/drift.md`:
- Around line 42-43: The two markdown links "Code analyze contracts" and "Code
repro" use relative paths ("analyze/" and "repro/") that resolve under the
current nested permalink; update those link targets to parent-relative or
absolute paths so they point to the intended pages (for example change
"analyze/" and "repro/" to "../analyze/" and "../repro/" or to their absolute
equivalents) ensuring the link texts remain the same.
In `@docs/bundles/spec/overview.md`:
- Around line 72-74: The "See-also" links (targets validate/, generate-tests/,
mock/) resolve one level too deep because they are relative to the current
overview folder; update those link targets to point to the sibling pages (e.g.,
change validate/ → ../validate/, generate-tests/ → ../generate-tests/, mock/ →
../mock/) so the links resolve to the intended sibling pages rather than nested
paths.
---
Duplicate comments:
In `@docs/bundles/govern/enforce.md`:
- Around line 60-61: The two relative links "[Govern patch](patch/)" and
"[Govern bundle overview](overview/)" are resolving under
/bundles/govern/enforce/ and should point to sibling pages under
/bundles/govern/; update those link targets to reference the sibling paths (for
example change to "../patch/" and "../overview/" or absolute
"/bundles/govern/patch/" and "/bundles/govern/overview/") so they resolve
correctly from the enforce page.
🪄 Autofix (Beta)
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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 07f3f66f-7600-4be9-bdb2-5298fc0b09d7
📒 Files selected for processing (6)
docs/bundles/code-review/run.mddocs/bundles/codebase/drift.mddocs/bundles/govern/enforce.mddocs/bundles/spec/overview.mddocs/bundles/spec/validate.mdopenspec/specs/missing-command-docs/spec.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/bundles/govern/enforce.md`:
- Line 35: Update the section heading `## \`specfact govern enforce sdd\`` to
match the documented command signature and examples by changing it to `##
\`specfact govern enforce sdd [BUNDLE]\``, so the heading aligns with Line 17
and the usage examples; locate the heading text in enforce.md and replace it
accordingly.
🪄 Autofix (Beta)
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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: c32f8f3a-3795-4fd3-b02a-52072a6d53d4
📒 Files selected for processing (4)
docs/bundles/code-review/run.mddocs/bundles/codebase/drift.mddocs/bundles/govern/enforce.mddocs/bundles/spec/overview.md
This was referenced Mar 27, 2026
Merged
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.
Summary
Validation