Writing release notes articles for tldraw SDK releases. Use when creating new release documentation, drafting release notes from scratch, or reviewing release note quality. Provides guidance on structure, voice, and content for release files in `apps/docs/content/releases/`.
This skill covers how to write a complete release notes article for a published tldraw SDK release.
All release files live in apps/docs/content/releases/.
| File | Purpose |
|---|---|
next.mdx | Accumulates changes for the upcoming release |
vX.Y.0.mdx | Published releases (immutable except for patch additions) |
Get the version number and find the GitHub release:
gh release view v4.3.0
This shows the release date, tag, and any release notes from GitHub.
List PRs merged between the previous release and this one:
# Find commits between releases
git log v4.2.0..v4.3.0 --oneline --merges
# Or use gh to list PRs
gh pr list --state merged --base main --search "merged:2024-01-01..2024-02-01"
For each PR, get the full details:
gh pr view <PR_NUMBER> --json title,body,labels,author,baseRefName
Look for:
### Release notes section in PR body### API changes section in PR bodyImportant: Only include PRs whose baseRefName is main. PRs merged into feature branches (e.g. default-shape-customization) are not yet released — they will be included when the feature branch itself is merged to main.
List any patch releases for this minor version:
gh release list | grep "v4.3"
For each patch release, find its PRs:
git log v4.3.0..v4.3.1 --oneline --merges
Create apps/docs/content/releases/vX.Y.0.mdx following the style guide.
Check that:
../shared/release-notes-guide.md for guidance on what a release notes article should contain and how to format it.