Skip to content

docs(reference): rewrite the changelog one change per bullet - #547

Merged
aicayzer merged 2 commits into
mainfrom
docs/rewrite-changelog
Oct 21, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/rewrite-changelog

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

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

  • Adds a v0.0.20 section. Its release holds only refactors and tests, so it says "No change for people running an instance or building on it."
  • Splits every bullet that held several changes, and adds bold lead-ins to v0.0.12 and older, which had none.
  • Moves the two Swift SDK entries out from between Marfa releases into Swift SDK releases, and adds Swift SDK v0.0.18, v0.0.19 and v0.0.22 to v0.0.24 from their release notes and the code at each tag. v0.0.1 to v0.0.17 have no notes of their own, and the section says so.
  • Removes the two "yet" promises from v0.0.19 (marfa audit and marfa export options).
  • Moves the inline contract links in v0.0.18 and v0.0.19 out of the prose. Each change links the docs page that explains the rule.
  • Drops the v0.0.12 bullet saying the Housekeeping job table is generated. It describes these docs, not a Marfa change.
  • Drops detail that the linked page holds, such as the file name marfa export --output falls back to and the exact lock-file message.
  • Shortens the upgrade paragraph and keeps it at the top.

Testing

  • pnpm test (28 files, 364 tests, including the content lint), pnpm build, pnpm build:status and pnpm types:check pass.
  • Checked every internal link and its anchor against the headings of the target page with a script. The script reports a broken anchor when one is planted.
  • Looked at /changelog at 1280 and 375 pixels wide. No horizontal scroll, and the on-page link to the Swift SDK v0.0.18 heading resolves.
  • Read /changelog.md.

Notes for reviewers

  • Facts were checked against the release notes and git log between tags in withmarfa/marfa, and against Sources/Marfa at each tag in withmarfa/marfa-swift.
  • Swift SDK v0.0.24 builds against a Marfa commit after v0.0.20, so its entry says "Marfa's core from after v0.0.20" rather than naming a release.
  • Links to /cli and /swift-sdk carry 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#fields and /catalog/field-kinds resolve today but need checking if that pull request renames those headings.
  • Heading anchors for every release are unchanged.

Checklist

  • One logical change
  • Follows STYLE.md
  • No edits under src/generated/ or to openapi.json
  • No URLs changed
  • No private hostnames, personal paths or tokens

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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, the failing_alone test, the lock-file message, marfa export --output behavior and details.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.

@aicayzer
aicayzer merged commit dc6f3f7 into main Oct 21, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/rewrite-changelog branch October 21, 2026 16:11
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.

1 participant