Repository navigation
docs(reference): rewrite the changelog one change per bullet - #547
Merged
Merged
Conversation
aicayzer
commented
Oct 21, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. Rewrites the Changelog one change per bullet and moves the Swift SDK releases to their own section; after review it conflicts with nothing, every link resolves, and no release lost a fact.
First draft: 2/5. It conflicted with main, broke four links, and dropped facts no linked page holds; all fixed in 4255676 and the commits after it.
Checked.
- True: every release's bullets compared before and after; v0.0.20's "No change" against its release notes; the Swift SDK entries against their release notes and the core commits they pin.
- Every path: all 98 internal links resolve.
Found.
- Conflicted with main after #549. Merged, keeping this branch's bullets and #549's link targets. Fixed in 4255676.
- Four links pointed at anchors #548 and #549 removed. Retargeted to the pages that now hold the content.
Every path - Facts dropped across v0.0.7 to v0.0.19, such as
PATCH /config's merge rule, thefailing_alonetest, the lock-file message,marfa export --outputbehavior anddetails.original_status. Restored.True - One v0.0.15 bullet changed meaning. It again says the run no longer fails when the key that started it is revoked.
True
Reviewed by withmarfa-reviewer on claude-sonnet-5-5. This review may contain mistakes.
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.
Summary
Rewrites the Changelog so each bullet is one change, in one or two sentences, with a bold lead-in and a link to the page that explains it. Every Marfa release keeps its own section, v0.0.20 included, and the Swift SDK releases move to one section after Marfa's.
Changes
marfa auditandmarfa exportoptions).marfa export --outputfalls back to and the exact lock-file message.Testing
pnpm test(28 files, 364 tests, including the content lint),pnpm build,pnpm build:statusandpnpm types:checkpass./changelogat 1280 and 375 pixels wide. No horizontal scroll, and the on-page link to the Swift SDK v0.0.18 heading resolves./changelog.md.Notes for reviewers
git logbetween tags in withmarfa/marfa, and againstSources/Marfaat each tag in withmarfa/marfa-swift./cliand/swift-sdkcarry no anchors, because those pages are being rewritten in a separate pull request. The links to/catalog/your-own-types#retention-policy,/catalog/your-own-types#fieldsand/catalog/field-kindsresolve today but need checking if that pull request renames those headings.Checklist
STYLE.mdsrc/generated/or toopenapi.json