Skip to content

feat(docs): add weekly update drafts#1183

Merged
jrusso1020 merged 1 commit into
mainfrom
06-03-weekly-updates-digest
Jun 4, 2026
Merged

feat(docs): add weekly update drafts#1183
jrusso1020 merged 1 commit into
mainfrom
06-03-weekly-updates-digest

Conversation

@jrusso1020
Copy link
Copy Markdown
Collaborator

@jrusso1020 jrusso1020 commented Jun 3, 2026

What

Adds the first weekly digest workflow for HyperFrames docs:

  • new bun run changelog:weekly --from YYYY-MM-DD --to YYYY-MM-DD [--write] [--force] command
  • new Mintlify docs/weekly-updates.mdx page, linked beside the versioned changelog
  • editable weekly packet outputs under updates/weekly/ and updates/social/
  • maintainer docs for the weekly digest process

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:

  • a docs <Update> block for docs/weekly-updates.mdx
  • a fuller editable source file
  • Discord and X draft copy

All 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:scripts
  • bun run changelog:weekly --from 2026-06-01 --to 2026-06-07
  • bun run format:check
  • bun run lint
  • bunx fallow audit --base origin/main --fail-on-issues
  • local docs navigation check for docs/docs.json page targets
  • Docs CI Validate docs

@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 3, 2026

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

Project Status Preview Updated (UTC)
hyperframes 🟢 Ready View Preview Jun 3, 2026, 11:08 PM

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

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Copy Markdown
Collaborator

@miguel-heygen miguel-heygen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
  • EEXIST guard + --force flag 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.

@jrusso1020 jrusso1020 merged commit 1abe69f into main Jun 4, 2026
54 of 92 checks passed
@jrusso1020 jrusso1020 deleted the 06-03-weekly-updates-digest branch June 4, 2026 00:27
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