docs(contracts): tracked-variable-v1 links its program doc by absolute URL, as its siblings do - #3437
Conversation
…e URL, as its siblings do `docs/contracts/tracked-variable-v1.md` is synced to every consumer (sync-manifest, source_tree: root), but the program doc it links, `research-backplane-contract.md`, is deliberately Workflows-only and never synced (the manifest says so at the entry above run-contract-v1). The relative link `./research-backplane-contract.md` therefore resolves nowhere in a consumer. run-contract-v1.md and identity-map-conventions.md already use the absolute GitHub URL for exactly this reason (#3354); this doc did not. Effect: Collab-Admin — the one consumer with a docs-link test (tests/test_docs_links.py, plus its "Validate documentation links" job) — has had its delivery PR #978 red in sync:delivery-staging since 2026-09-05, the only open delivery PR in the consumer set. Every other consumer carries the same blob (fea385b) and simply does not check links. The next delivery corrects all of them. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
Warning Review limit reachedNext included review available in 4 seconds. View limit detailsLimit details: You’ve used the included review currently available. Your 66 included PR review attempts over the past 7 days set your current allowance at 1 review per hour. Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab. Review configuration: ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Essentials Run ID: 📒 Files selected for processing (1)
Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Gate fast-pass: docs-only change detected; heavy checks skipped. |
Automated Status SummaryHead SHA: 9a2121d
Updated automatically; will refresh on subsequent CI/Docker completions. Keepalive checklistScopeNo scope information available Tasks
Acceptance criteria
|
There was a problem hiding this comment.
🟢 Approval recommended
The scoped documentation change has no unresolved review comments.
Pull request overview
Updates the tracked-variable contract to use the correct link to its Workflows-only program documentation.
Changes:
- Replaces the broken relative link with the canonical absolute GitHub URL.
- Clarifies that the target document is not synced to consumers.
File summaries
| File | Description |
|---|---|
docs/contracts/tracked-variable-v1.md |
Corrects the program-document link for consumer copies. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Why
docs/contracts/tracked-variable-v1.mdis synced to every consumer (sync-manifest.yml,source_tree: root), but the program doc it links,research-backplane-contract.md, is deliberately Workflows-only and never synced — the manifest says so just above therun-contract-v1entry. The relative link./research-backplane-contract.mdtherefore resolves nowhere in a consumer.run-contract-v1.mdandidentity-map-conventions.mdalready use the absolute GitHub URL for exactly this reason (#3354); this doc did not.Effect today
Collab-Admin is the one consumer with a docs-link test (
tests/test_docs_links.pyplus its "Validate documentation links" job). Its delivery PR stranske/Collab-Admin#978 has been red insync:delivery-stagingsince 2026-09-05 on precisely this link — the only open delivery PR in the consumer set. Every other consumer carries the same blob (fea385b) and simply does not check links. The next delivery corrects all of them.Change
One line: the link becomes
https://github.com/stranske/Workflows/blob/main/docs/contracts/research-backplane-contract.md, with a parenthetical saying the target is Workflows-only. The target exists onmain.🤖 Generated with Claude Code