Repository navigation
docs(plans): mark each planning record with its shipped status - #1198
Merged
Merged
Conversation
Every file under docs/plans/ now opens with one line saying it is a planning record, its status, and that the code wins. The README table covers all 27 records and corrects the 770 and 788 rows.
mforce
marked this pull request as ready for review
October 10, 2026 22:04
…docs/plans-status-banners
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.
Agents searching the repo land inside
docs/plans/files and treat them as current guidance. The README already says plans are historical, but agents rarely open it. Its table also listed 4 of the 27 records, and two of those rows were wrong:770-mcp-serverand788-mcp-oauthsaid "Design only; no code written" after #788 and #805 shipped.This PR changes documentation only. No plan's content changes.
.mdfiles underdocs/plans/except the README now opens with one line above its title. The line says the file is a planning record, gives its status, says the code wins where they disagree, and links to the README with a relative path that matches the file's depth.A script inserted the lines, then a second script checked that every file has exactly one status line, on line 1, directly above a
#heading, with a link that resolves todocs/plans/README.md(ok: 86 files, one status line each). The scripts are not committed.Status per record
Sources are
gh issue view <n> --json state,stateReason,closedByPullRequestsReferencesplus the merged PRs that name each issue. Two closing references were release PRs (#784 on #770, #802 on #839), so I left them out.357-change-user-email/388-worker-flock-read-scoping.md500-seeded-audit-actor/508-audit-monotonic-order/562-tenant-write-token/585-587-login-credentials/606-step-up-flock-scope/612-worker-sale-allocation/651-652-spa-elevation-and-caps/653-655-list-screens/670-user-roles-account-id/672-fake-otlp-collector/703-shared-dialog-session/721-discount-reason/722-audit-price-payload/723-724-discount-visibility/727-discount-ceiling/732-rename-account-verb/745-audit-details-column/770-mcp-server/788-mcp-oauth/822-mui-revamp/839-integration-wall-clock/840-integration-flakes/863-integration-collection-split/audit-entity-history/screenshot-pipeline-and-conventions/The 770 row will go stale when epic #789 closes. Whoever closes it updates this row and the six 770 status lines.
Guards run
TenancyDocsFreshnessTestswalks every tracked file for dormant-tenancy wording and the Postgres and Redis image pins.RenameAccountDocsTestsreads732-rename-account-verb/02-implementation-runbook.md. Together: 19 passed, 0 failed.SchemaDocsTestsonly enumeratesdocs/schema/, and no schema doc changed, so I did not run it orgenerate.sh --check.