Skip to content

chore: remove committed design notes and ignore docs/contracts - #5107

Merged
miguel-heygen merged 2 commits into
mainfrom
chore/drop-committed-design-notes
Oct 6, 2026
Merged

miguel-heygen merged 2 commits into
mainfrom
chore/drop-committed-design-notes

Conversation

@miguel-heygen

@miguel-heygen miguel-heygen commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

What

Removes the plan and contract notes that landed on main, and ignores docs/contracts/ the same way docs/plans/ is already ignored.

  • 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 (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_DELETIONS in scripts/check-no-main-deletions.mjs, with one shared reason, so the main deletion guard accepts it.

Checks

  • Nothing in the repo links to the removed files (git grep over the tree).
  • node scripts/check-no-main-deletions.mjs --base origin/main passes (it failed on the first commit), and scripts/check-no-main-deletions.test.mjs passes 8/8 three times.
  • git check-ignore matches new files under both docs/contracts/ and docs/plans/.

Size

7 files, +10 / -340. Docs, .gitignore, and five allowlist entries.

@mintlify

mintlify Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 6, 2026, 5:19 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@somanshreddy somanshreddy 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.

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

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

@miguel-heygen
miguel-heygen added this pull request to the merge queue Oct 6, 2026
Merged via the queue into main with commit 6308727 Oct 6, 2026
107 checks passed
@miguel-heygen
miguel-heygen deleted the chore/drop-committed-design-notes branch October 6, 2026 06:25
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