docs(rfc): state qualified identifiers in the RFC headers#412
Merged
Conversation
RFC numbers are assigned per repo, so a bare "RFC 0001" names four different documents across the org and "RFC 0002"/"RFC 0003" name two each. Add the qualified ID (`RFC-CLI-0001` … `RFC-CLI-0003`) to each header, in the blockquote style these documents already use. Two of the three also record which document the existing bare in-code references actually mean: nearly all `RFC-0001` comments across backend/cli/client point at RFC-CLI-0001, and the `RFC-0003` references in client's chart templates and docs/SEAL-CHECK.md point at RFC-CLI-0003 — not at backend's own 0001/0003. Nothing is renumbered and no file is moved, so existing links still resolve. The org-wide index lives in tracebloc/backend (private) at docs/rfcs/README.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This was referenced Jul 25, 2026
Merged
Contributor
Author
|
👋 Heads-up — Code review queue is at 38 / 30 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
Contributor
Author
|
bugbot run |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 2b0bd8a. Configure here.
saadqbal
approved these changes
Jul 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
RFC numbers are assigned per repo, so the same number names different documents in different repos. Today a bare
0001names four different documents across the org, and0002/0003name two each. "RFC 0001" is ambiguous in conversation, and that ambiguity was hit in practice this week.This PR states an explicit qualified identifier in each cli RFC header:
RFC-CLI-0001,RFC-CLI-0002,RFC-CLI-0003.Nothing is renumbered and no file is moved, so every existing link and cross-reference still resolves. The headers keep the blockquote style these documents already use.
Why this matters here specifically
The cli RFCs are the ones most often cited from other repos, and they are cited by bare number:
RFC-0001reference inbackend(auth, DNS-1123 slugs, audit log, CLI-version handshake) and inclient(CODEOWNERS, release workflow, R8 signed installer) meansRFC-CLI-0001— not the local repo's own0001.RFC-0003reference inclient's chart templates anddocs/SEAL-CHECK.mdmeansRFC-CLI-0003— not backend's0003.A reader who follows one of those to their local
docs/rfcs/0001-*.mdlands on the wrong document. SoRFC-CLI-0001andRFC-CLI-0003now say in their headers which bare references point at them.The 288 existing bare references org-wide are deliberately left alone — rewriting them across three repos is high-risk churn with no reader benefit now that the index disambiguates them. Use qualified IDs in anything new.
The org-wide index
One index lists every RFC in the org with its qualified ID, title, status and link. It lives in
tracebloc/backend(private) atdocs/rfcs/README.md— an index that names internal work, closed proposals and unshipped design must not sit in a public repo.cli/docs/rfcs/has no README of its own, so nothing here references it beyond the one-line pointer in each header.The index also adopts the rule that an RFC's status (
Draft/Accepted/Superseded/Rejected) lives in the document header, never as a kanban column, and that a discussion PR either merges (accepted) or closes (rejected) rather than lingering.Companion PRs
backendclientclientRFC-CLIENT-0002: renumbered off a within-repo collision, status Accepted, un-draftedIn-flight: tracebloc/backend#1146 adds
backend/docs/rfcs/0002-platform-cost-autoscale-architecture.md. It will need the same header treatment (RFC-BACKEND-0002) when it merges — it is already listed in the index.Test plan
Docs-only; no code, no build inputs touched. Verified all three documents render and that no file path or link changed.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only header blockquotes with no runtime, build, or link-path changes.
Overview
Adds a qualified identifier blockquote to each of the three CLI RFCs (
RFC-CLI-0001throughRFC-CLI-0003) so they are not confused with same-numbered RFCs inbackendorclient.Each header now tells readers to cite the qualified ID (not bare "RFC 0001"), notes which cross-repo bare references usually mean that CLI doc, and points at the org-wide index in
tracebloc/backendatdocs/rfcs/README.md. No renumbering, moves, or link rewrites — existing paths and the hundreds of legacy bare references stay as-is.Reviewed by Cursor Bugbot for commit 2b0bd8a. Bugbot is set up for automated code reviews on this repo. Configure here.