feat(docs): add weekly update drafts#1183
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
miguel-heygen
approved these changes
Jun 3, 2026
Collaborator
miguel-heygen
left a comment
There was a problem hiding this comment.
Clean addition. Follows the existing changelog script patterns exactly — same CLI arg parsing, same shouldSkipCommit filter, same parseCommit reuse. A few notes:
- Editorial scope filtering (docs/readme/skills excluded from highlights) is the right call
EEXISTguard +--forceflag mirrors the draft-changelog convention well- All outputs stay human-reviewed with TODO markers — nothing auto-posts
- Test coverage hits the three important cases (arg parsing, draft rendering, path generation)
One minor thing: selectHighlights hardcodes 5 — fine for now, easy to parameterize later if needed.
LGTM.
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.

What
Adds the first weekly digest workflow for HyperFrames docs:
bun run changelog:weekly --from YYYY-MM-DD --to YYYY-MM-DD [--write] [--force]commanddocs/weekly-updates.mdxpage, linked beside the versioned changelogupdates/weekly/andupdates/social/Why
We already have versioned release notes for exact package releases. This adds a separate editorial surface for weekly rollups so we can highlight the highest-impact work across multiple releases and adapt the same reviewed source for Discord/X without mixing it into the exact release changelog.
How
The weekly command reads conventional commits from the selected Git date range, filters release/bump/skip-changelog commits, selects up to five user-facing highlights, and generates:
<Update>block fordocs/weekly-updates.mdxAll generated outputs keep a TODO review marker so publishing remains human-reviewed. Social drafts are created only as files; nothing posts automatically.
Test plan
bun run test:scriptsbun run changelog:weekly --from 2026-06-01 --to 2026-06-07bun run format:checkbun run lintbunx fallow audit --base origin/main --fail-on-issuesdocs/docs.jsonpage targetsValidate docs