Skip to content

Generated Reference Signposts (Cycle 0027) - #14

Merged
flyingrobots merged 3 commits into
mainfrom
cycles/0027-generated-reference-signposts
Apr 7, 2026
Merged

flyingrobots merged 3 commits into
mainfrom
cycles/0027-generated-reference-signposts

Conversation

@flyingrobots

Copy link
Copy Markdown
Owner

Summary

CLI.md and MCP.md are now generated from source code during method sync ship:

  • CLI.md — built from CLI_TOPICS + usage() in cli-args.ts
  • MCP.md — built from MCP_TOOLS array in mcp.ts
  • Both carry generated_from_commit SHA in frontmatter
  • These docs can never drift from the implementation

Also includes ship sync for cycle 0026 (CHANGELOG + BEARING).

Test plan

  • 122 tests pass
  • Build clean
  • method sync ship regenerates both docs
  • Cycle closed with retro and witness

Generate CLI.md and MCP.md from source code during ship sync.
- CLI.md generated from CLI_TOPICS + usage() in cli-args.ts
- MCP.md generated from MCP_TOOLS array in mcp.ts
- Both carry generated_from_commit SHA in frontmatter
- MCP tool definitions extracted to shared MCP_TOOLS export
- CLI topics exported as CLI_TOPICS constant
- shipSync now regenerates CLI.md and MCP.md on every run
- Ship sync for cycle 0026 included

122 tests pass.
Hill met. CLI.md and MCP.md now generated from source during ship sync.
122 tests pass. No drift.
@coderabbitai

coderabbitai Bot commented Apr 7, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@flyingrobots has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 30 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 1 minutes and 30 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6ee8adec-5c92-41db-b127-7c57aee06459

📥 Commits

Reviewing files that changed from the base of the PR and between 46ef200 and c5d2941.

📒 Files selected for processing (11)
  • CHANGELOG.md
  • docs/BEARING.md
  • docs/CLI.md
  • docs/MCP.md
  • docs/design/0027-generated-reference-signposts/generated-reference-signposts.md
  • docs/method/retro/0027-generated-reference-signposts/generated-reference-signposts.md
  • docs/method/retro/0027-generated-reference-signposts/witness/verification.md
  • src/cli-args.ts
  • src/index.ts
  • src/mcp.ts
  • tests/docs.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cycles/0027-generated-reference-signposts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@flyingrobots
flyingrobots merged commit 03d889d into main Apr 7, 2026
2 of 3 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c5d29417b1

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/index.ts

private currentCommitSha(): string {
try {
return execSync('git rev-parse HEAD', { cwd: this.root, encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] }).trim();

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use current tree id for generated_from_commit

shipSync() stamps docs with git rev-parse HEAD, which is always the last committed revision, not the workspace state that actually produced the regenerated files. In the normal flow (edit code, run method sync ship, then commit), docs/CLI.md and docs/MCP.md will record a commit that can predate the command/tool definitions they contain, so provenance-based drift checks can be misled. Please derive this value from the current tree/workspace state instead of pre-sync HEAD.

Useful? React with 👍 / 👎.

@flyingrobots
flyingrobots deleted the cycles/0027-generated-reference-signposts branch April 7, 2026 07:08
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