Repository navigation
chore: remove committed design notes and ignore docs/contracts - #5107
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
somanshreddy
left a comment
There was a problem hiding this comment.
Review at 5c592f48 (full PR). This is a comment, not an approval.
Blocker: required CI is red, and the PR causes it. In CI run 37417562907 at this head, Detect changes fails at "Reject accidental file deletions" (scripts/check-no-main-deletions.mjs --base origin/main):
This branch deletes 5 files that exist on origin/main:
docs/contracts/2026-10-01-timeline-filmstrip.html
docs/contracts/2026-10-02-ghost-lane-membership.html
docs/contracts/2026-10-02-thumbnail-document-lifetime.html
docs/contracts/2026-10-05-transcribe-language-progress.html
docs/plans/2026-09-26-image-thumbnails.md
Typecheck, Build, Test and Test: runtime contract then fail at "Require change detection". The guard deliberately has no flag or env escape (check-no-main-deletions.mjs:30). The only exemption is an entry per path, with a reason, in ALLOWED_DELETIONS (:45). The "exempt mark" in the PR description doesn't reach this check. Fix: add the 5 paths to ALLOWED_DELETIONS with a one-line reason, or drop the deletions and keep only the .gitignore change.
Otherwise fine. Nothing outside docs/contracts/ and docs/plans/ refers to any of the 5 files (I searched the head tree for each file's base name). The .gitignore entry for docs/contracts/ matches the existing docs/plans/ one.
CI at this head: 21 pass, 5 fail (the guard plus the 4 that depend on it), 32 skipped.
— Somu
somanshreddy
left a comment
There was a problem hiding this comment.
Approving at 634c2495. The blocker from my 5c592f48 review is fixed: the 5 deleted notes are now listed in ALLOWED_DELETIONS with a shared reason (check-no-main-deletions.mjs:45-47, :1133-1137), and Detect changes, Typecheck, Build and Test: runtime contract pass at this head. Nothing outside docs/contracts and docs/plans references the removed files. — Somu
What
Removes the plan and contract notes that landed on main, and ignores
docs/contracts/the same waydocs/plans/is already ignored.docs/contracts/2026-10-01-timeline-filmstrip.htmldocs/contracts/2026-10-02-ghost-lane-membership.htmldocs/contracts/2026-10-02-thumbnail-document-lifetime.htmldocs/contracts/2026-10-05-transcribe-language-progress.htmldocs/plans/2026-09-26-image-thumbnails.md(tracked despite the existing ignore rule)Why
These are working notes for the PRs that shipped them, not docs for users. They stay with their authors and get summarized in PR bodies instead.
Each removal is recorded in
ALLOWED_DELETIONSinscripts/check-no-main-deletions.mjs, with one shared reason, so the main deletion guard accepts it.Checks
git grepover the tree).node scripts/check-no-main-deletions.mjs --base origin/mainpasses (it failed on the first commit), andscripts/check-no-main-deletions.test.mjspasses 8/8 three times.git check-ignorematches new files under bothdocs/contracts/anddocs/plans/.Size
7 files, +10 / -340. Docs,
.gitignore, and five allowlist entries.