Skip to content

docs(contracts): tracked-variable-v1 links its program doc by absolute URL, as its siblings do - #3437

Merged
stranske merged 1 commit into
mainfrom
fix/tracked-variable-doc-link
Sep 14, 2026
Merged

stranske merged 1 commit into
mainfrom
fix/tracked-variable-doc-link

Conversation

@stranske

Copy link
Copy Markdown
Owner

Why

docs/contracts/tracked-variable-v1.md is 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 the run-contract-v1 entry. 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 today

Collab-Admin is the one consumer with a docs-link test (tests/test_docs_links.py plus its "Validate documentation links" job). Its delivery PR stranske/Collab-Admin#978 has been red in sync:delivery-staging since 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 on main.

🤖 Generated with Claude Code

…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>
Copilot AI lite review requested due to automatic review settings September 14, 2026 02:18
@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 4 seconds.

Check out review usage here.

View limit details

Limit 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.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Essentials

Run ID: c17fe04c-95af-4616-924e-fe0e79c1debf

📥 Commits

Reviewing files that changed from the base of the PR and between 569875f and 1aff86f.

📒 Files selected for processing (1)
  • docs/contracts/tracked-variable-v1.md

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

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 14, 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-09-14T02:20:06.417035Z 1aff86f 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.

@stranske-keepalive

Copy link
Copy Markdown
Contributor

Gate fast-pass: docs-only change detected; heavy checks skipped.

@stranske-keepalive

Copy link
Copy Markdown
Contributor

Automated Status Summary

Head SHA: 9a2121d
Latest Runs: ⏳ pending — Gate
Required contexts: summary
Required: core tests (3.12): ⏳ pending, core tests (3.13): ⏳ pending, docker smoke: ⏳ pending, gate: ⏳ pending

Workflow / Job Result Logs
(no jobs reported) ⏳ pending

Updated automatically; will refresh on subsequent CI/Docker completions.


Keepalive checklist

Scope

No scope information available

Tasks

  • No tasks defined

Acceptance criteria

  • No acceptance criteria defined

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 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.

@stranske
stranske merged commit 35bdde2 into main Sep 14, 2026
43 checks passed
@stranske
stranske deleted the fix/tracked-variable-doc-link branch September 14, 2026 02:19
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