docs: add release migration-guide page for breaking changes and deprecations#6517
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Stay up to date” documentation section to make release tracking and upgrades easier, including a structured home for migration guides covering breaking changes and deprecations. It also aligns changelogs, templates, and internal release/deprecation guidance with that new documentation workflow, and improves docs generation ergonomics.
Changes:
- Add new release docs pages: “Stay up to date” index, release notes, compatibility policy, and version-scoped breaking-change/deprecation migration guides; wire them into the docs sidebar.
- Update existing docs examples/links (e.g., solitaire tutorial, declarative dialogs) to match current APIs and improve typed cross-references.
- Improve docs build robustness (skip PyPI index in fast mode; clearer PyPI fetch error formatting) and reorganize changelog sections + PR/release process guidance.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/sidebars.yml | Adds “Stay up to date” section and release/migration guide entries to the sidebar source. |
| website/sidebars.js | Regenerates sidebar output to include the new “Stay up to date” structure. |
| website/docs/tutorials/solitaire.md | Updates tutorial snippets to use Border / BorderRadius classmethods instead of removed helpers. |
| website/docs/release/release-notes.md | Introduces a release notes hub linking announcements/changelogs/migration guides. |
| website/docs/release/index.md | Adds “Stay up to date” landing page linking to release notes, migration guides, and policy. |
| website/docs/release/compatibility-policy.md | Documents breaking-change and deprecation policy and where to find upgrade info. |
| website/docs/release/breaking-changes/index.md | Adds the index page for migration guides grouped by release. |
| website/docs/release/breaking-changes/removed-spacing-border-helpers.md | Adds a migration guide for removed spacing/border helper functions. |
| website/docs/release/breaking-changes/deprecated-drag-target-event-coordinates.md | Adds a migration guide for deprecated DragTargetEvent coordinate fields. |
| website/docs/release/breaking-changes/deprecated-video-apis.md | Adds a migration guide for deprecated Video control APIs. |
| website/docs/cookbook/declarative-dialogs.md | Switches key API links to typed reference links for better durability. |
| tools/crocodocs/src/crocodocs/pypi_index.py | Improves PyPI index fetch failure rendering (fenced output for readability). |
| tools/crocodocs/src/crocodocs/partials.py | Adds FLET_DOCS_FAST behavior to skip PyPI index generation in fast docs builds. |
| sdk/python/packages/flet-video/CHANGELOG.md | Separates “Changed” vs “Deprecated” entries for video API changes. |
| packages/flet/CHANGELOG.md | Removes empty section headers to match updated changelog structure. |
| CHANGELOG.md | Splits breaking changes and deprecations into dedicated sections for the release. |
| .github/pull_request_template.md | Updates PR template wording/checklist to emphasize docs/changelog/release-guide updates. |
| .agents/skills/prepare-flet-release/SKILL.md | Aligns release prep steps and changelog section ordering with new release docs workflow. |
| .agents/skills/flet-deprecation/SKILL.md | Documents required release-doc updates when introducing deprecations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment was marked as resolved.
This comment was marked as resolved.
Deploying flet-website-v2 with
|
| Latest commit: |
f66df42
|
| Status: | ⚡️ Build in progress... |
Deploying flet-examples with
|
| Latest commit: |
f66df42
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://695012b8.flet-examples.pages.dev |
| Branch Preview URL: | https://docs-migration-guide.flet-examples.pages.dev |
Open
1 task
This comment was marked as resolved.
This comment was marked as resolved.
FeodorFitsner
approved these changes
May 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix #6172
Summary by Sourcery
Add a dedicated docs section for staying up to date with releases, including migration guides for breaking changes and deprecations, and align changelog, templates, and internal release/deprecation workflows with this structure.
New Features:
Bug Fixes:
Border,BorderRadius, and related APIs instead of removed helper functions.Enhancements:
Documentation:
DragTargetEventcoordinate fields, and deprecated video control APIs, including timelines and references.