Skip to content

docs: fix review gate README anchor#436

Open
CooperSheroy wants to merge 1 commit into
openai:mainfrom
CooperSheroy:catalina/readme-review-gate-anchor-20260705
Open

docs: fix review gate README anchor#436
CooperSheroy wants to merge 1 commit into
openai:mainfrom
CooperSheroy:catalina/readme-review-gate-anchor-20260705

Conversation

@CooperSheroy

Copy link
Copy Markdown

Summary

  • update the README Codex resume section to link to the existing review gate heading
  • add a command-docs regression assertion so the stale anchor does not return

Verification

  • node --test tests/commands.test.mjs
  • git diff --check
  • node -e README anchor check for #enabling-review-gate

Note: an initial full npm test run was stopped after it appeared stuck after test 77; all emitted tests up to that point had passed. The focused docs test above passed after the change.

@CooperSheroy CooperSheroy requested a review from a team July 5, 2026 03:40

@rajpratham1 rajpratham1 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a straightforward documentation fix with an appropriate regression test.

Review
README fix ✅

The link changes from:

stop gate

to

review gate

This fixes a broken internal anchor and also updates the terminology to match the current documentation.

Regression test ✅

The added assertions verify both:

the new anchor exists
assert.match(readme, /[review gate](#enabling-review-gate)/i);
the old broken anchor is gone
assert.doesNotMatch(readme, /#what-does-the-review-gate-do/i);

This prevents future documentation regressions.

Risk

None.

Only documentation and a documentation validation test are modified.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants