Skip to content

docs: move the 3.0 upgrade notes out of the README - #16

Merged
emanuilo merged 1 commit into
mainfrom
docs/upgrade-guide
Oct 18, 2026
Merged

emanuilo merged 1 commit into
mainfrom
docs/upgrade-guide

Conversation

@emanuilo

Copy link
Copy Markdown
Owner

Summary

 README.md (Quick Start)
-  **Upgrading from 2.x to 3.0** — 6 lines of notes
+  Upgrading from 2.x? See [Upgrading](docs/upgrading.md) for what changed in 3.0.
 docs/
+└── upgrading.md   # the same notes + upgrade commands + link to the v3.0.0 release

Evidence

  • Before: the upgrade notes took up much of the README's Quick Start section.
    After: one line in the README; the full notes in docs/upgrading.md.

Merge Danger

Door: two-way

Docs only.

Blast Radius: docs

The README on PyPI stays as published with 3.0.0 until the next release.

🤖 Generated with Claude Code

They took a lot of the Quick Start section. They now live in
docs/upgrading.md, with a one-line pointer in the README.
@emanuilo
emanuilo merged commit 5941e3a into main Oct 18, 2026
4 checks passed
@emanuilo
emanuilo deleted the docs/upgrade-guide branch October 18, 2026 18:15
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