Skip to content

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

Closed
MaximBazarov wants to merge 6 commits into
mainfrom
fm/sm-readme-version
Closed

MaximBazarov wants to merge 6 commits into
mainfrom
fm/sm-readme-version

Conversation

@MaximBazarov

@MaximBazarov MaximBazarov commented Sep 14, 2026 •

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.

@MaximBazarov MaximBazarov changed the title docs: compile README examples and check version drift in CI docs: update README to v0.9.4 and gate snippet drift Sep 14, 2026
@MaximBazarov
MaximBazarov deleted the fm/sm-readme-version branch September 14, 2026 07:35
@MaximBazarov
MaximBazarov restored the fm/sm-readme-version branch September 14, 2026 07:36
@MaximBazarov MaximBazarov reopened this Sep 14, 2026
@MaximBazarov
MaximBazarov deleted the fm/sm-readme-version branch September 14, 2026 07:36
@MaximBazarov
MaximBazarov restored the fm/sm-readme-version branch September 14, 2026 07:37
@MaximBazarov MaximBazarov reopened this Sep 14, 2026
@MaximBazarov

Copy link
Copy Markdown
Owner Author

Closing so the same commits can reopen under maxim/readme-version-0.9.4 (branch naming convention). No product change; body already rewritten for human review.

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