Skip to content

docs: update README to v0.9.4 and gate snippet drift - #4

Merged
MaximBazarov merged 6 commits into
mainfrom
maxim/readme-version-0.9.4
Sep 14, 2026
Merged

MaximBazarov merged 6 commits into
mainfrom
maxim/readme-version-0.9.4

Conversation

@MaximBazarov

Copy link
Copy Markdown
Owner

Summary

Bumps the README version line from v0.9.2 to v0.9.4 so it matches the current CHANGELOG release, and updates the QuickStart read/write example to the 0.9.4 API.

Also keeps those README Swift blocks from drifting: they now live in Snippets/, swift build compiles them, and CI runs Scripts/check-docs.sh (documented under Project layout in CONTRIBUTING).

Review notes

  • Scope is docs + a drift guard only; library behavior is unchanged.
  • The unreferenced-snippet reverse check was intentionally dropped — CI only enforces that README blocks still match their owned snippet files.
  • Continues the same commits formerly on docs: update README to v0.9.4 and gate snippet drift #3 after renaming the head branch to maxim/readme-version-0.9.4.

@MaximBazarov
MaximBazarov merged commit cda0978 into main Sep 14, 2026
12 of 16 checks passed
@MaximBazarov
MaximBazarov deleted the maxim/readme-version-0.9.4 branch September 14, 2026 09:34
MaximBazarov added a commit that referenced this pull request Sep 14, 2026
* Update the README version badge to v0.9.4.

* no-mistakes(document): Fix stale README read/write example for 0.9.4 API

* no-mistakes(document): Compile-check README examples and gate version drift in CI

* no-mistakes(review): Drop unreferenced-snippet reverse check from docs drift script

* no-mistakes(review): List Scripts/ in CONTRIBUTING project layout

* no-mistakes(document): Name the compile-checked README examples
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