Skip to content

docs: Add v1.38.0 to v2.0.0 migration guide#3963

Merged
spydon merged 2 commits into
mainfrom
docs/v2-migration-guide
Jul 22, 2026
Merged

docs: Add v1.38.0 to v2.0.0 migration guide#3963
spydon merged 2 commits into
mainfrom
docs/v2-migration-guide

Conversation

@spydon

@spydon spydon commented Jul 22, 2026

Copy link
Copy Markdown
Member

Description

Adds a new "Migration Guides" page to the docs describing the breaking changes users need to be
aware of when upgrading between major versions of Flame, along with the steps required to migrate.

This first version covers migrating from v1.38.0 to v2.0.0. To start with, it documents the one
breaking change that has landed on main since the v1.38.0 tag:

The page is registered in the Flame section's toctree (right after "Getting Started") so it is
discoverable in the rendered docs. As more breaking PRs land before the v2.0.0 release, new
subsections can be appended under the same version heading.

Changed files:

  • doc/flame/migration.md (new page)
  • doc/flame/flame.md (added the page to the visible list and hidden toctree)

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • [-] I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • [-] I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

@spydon
spydon enabled auto-merge (squash) July 22, 2026 13:13
@spydon
spydon merged commit bbc43cb into main Jul 22, 2026
8 checks passed
@spydon
spydon deleted the docs/v2-migration-guide branch July 22, 2026 13:23
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.

2 participants