Skip to content

docs: fix nonexistent schema-0NN-rollout.md reference in backup runbook - #266

Merged
PetrefiedThunder merged 1 commit into
mainfrom
grok/amw-runbook-link-fix
Oct 27, 2026
Merged

PetrefiedThunder merged 1 commit into
mainfrom
grok/amw-runbook-link-fix

Conversation

@PetrefiedThunder

@PetrefiedThunder PetrefiedThunder commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes main red from #265: gateway/docs/backup-restore-runbook.md referenced schema-0NN-rollout.md in backticks, which test_docs_markdown_references_exist treats as a file reference. Changed to plain text "schema-NNN rollout doc". One line, docs only.

Local: tests/test_docs_reference_integrity.py 1 failed / 8 passed on main 2674423, 9 passed after fix.

Reviewer: Claude.


Note

Low Risk
Single-line documentation wording change with no effect on application code or deployment procedures.

Overview
Fixes a docs reference integrity failure in the backup/restore runbook verification section.

Item 6 previously used backticks around schema-0NN-rollout.md, which test_docs_markdown_references_exist treats as a concrete markdown path. That placeholder file does not exist in the tree. The wording is now plain text—schema-NNN rollout doc—with the same meaning (per-revision checks like legacy permits for 040, demo kill switch for 043, etc.).

No runtime or operational behavior changes; this unblocks the docs markdown reference test from #265.

Reviewed by Cursor Bugbot for commit 7497f7b. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel

vercel Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
agent-middleware-web Ready Ready Preview Oct 27, 2026 6:03am UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-27T06:04:14.925741Z 7497f7b PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 2674423 and 7497f7b.

Files selected for processing: 1
  • gateway/docs/backup-restore-runbook.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 2 remain after this review.

Walkthrough

The revision-specific verification item in the backup and restore runbook now refers to the matching schema-NNN-rollout.md document instead of schema-0NN-rollout.md.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: Minimal · up to 7497f

The runbook reference is corrected without introducing runtime or documentation-integrity risk.

Architecture risk: Low · up to 7497f

The change affects 1 system.

Changed systems: gateway

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — gateway (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in gateway/docs/backup-restore-runbook.md: The verification step now refers to the matching schema-NNN-rollout.md rollout document rather than schema-0NN-rollout.md.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the documentation fix for the nonexistent schema-0NN-rollout.md reference, which is the main change.
Description check Passed The description directly explains the documentation change, the test failure it fixes, and the validation result.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@PetrefiedThunder PetrefiedThunder left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

REVIEW: PASS claude 7497f7b

Scope: 1 commit, 1 file, +1/-1, gateway/docs/backup-restore-runbook.md:474. It changes the backticked schema-0NN-rollout.md to the plain-prose "schema-NNN rollout doc". The meaning is unchanged and nothing else in the diff changes (merge-base 2674423 = main tip, #265).

Reference check: the head has no other 0NN/NNN token. The new text has no backticks and no .md name, so neither the doc-reference gate nor the markdown-existence check sees it as a link.

Local, scratch worktree at this head (load ~18–24):

  • tests/test_docs_reference_integrity.py: 9 passed.
  • The same file with the base runbook swapped in: test_docs_markdown_references_exist FAILS on backup-restore-runbook.md: schema-0NN-rollout.md. This matches main CI run 40458242079 (Python 3.12/3.13), so the fix is the cause.
  • scripts/check_doc_references.py: 850 refs OK. tests/test_docs_links.py and tests/test_check_doc_references.py: 24 passed.

CI at this head: CI result, lint, gitleaks, CodeQL (3 analyzers), licenses, CodeRabbit, Cursor Bugbot and Vercel all pass. The matrix and Postgres jobs are skipped because this is a docs-only path filter, so the docs test ran here locally only.

@PetrefiedThunder
PetrefiedThunder merged commit 2b165fb into main Oct 27, 2026
23 checks passed
@PetrefiedThunder
PetrefiedThunder deleted the grok/amw-runbook-link-fix branch October 27, 2026 06:08

This branch was successfully deployed

1 active deployment
Preview — 7497f7ba Deployed Oct 27, 2026 by vercel[bot]
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.

1 participant