-
Notifications
You must be signed in to change notification settings - Fork 601
Docs for Flet 1.0 Beta #5929
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs for Flet 1.0 Beta #5929
Conversation
Introduces a new example app demonstrating a declarative component dialog in Flet. The dialog asynchronously loads user data from an API and displays it, including error handling and loading state.
Enhanced the README to better highlight Flet's cross-platform capabilities, Python-only development, built-in controls, packaging, extensibility, and accessibility. Updated example code for alignment and removed unnecessary page updates. Simplified web app run instructions. Also cleaned up the docs index to remove extra front matter.
Changed feature section headings to include relevant icons with updated width and vertical alignment for improved visual consistency and clarity.
Changed image width from 28 to 24 and replaced inline style with align="middle" for better consistency and compatibility in README.md.
Changed the 'align' attribute of badge images from 'middle' to 'bottom' for improved visual consistency in the README.
Changed all feature section images to use 'align="top"' and standardized image widths for consistency. Removed inline styles and improved visual alignment of icons with section headings.
Sets the logo image height to 100 for improved display consistency in the README file.
Updated the Flet logo image height from 100 to 150 in the README for improved visibility.
Updated the badge section in README.md to use consistent HTML formatting and self-closing img tags for improved readability and maintainability.
Removed Poetry-specific instructions and tabs from getting started, installation, and running app documentation to streamline setup guidance. Updated README and index with consistent usage of MainAxisAlignment and improved introductory example for Flet apps.
Improved formatting in README.md for better readability. Added a work-in-progress warning to mobile testing docs and updated admonition types. Changed section headings in iOS publishing guide from 'Step X' to subheadings for consistency. Set toc_depth to 3 in mkdocs.yml for deeper table of contents.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've reviewed this pull request using the Sourcery rules engine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the Flet documentation for the 1.0 Beta release, repositioning Flet as a Python-only framework for building cross-platform applications without frontend experience. The changes streamline getting-started guidance, remove Poetry-specific instructions, and enhance feature highlights.
- Simplified installation and setup documentation by focusing on
uvandpipworkflows - Enhanced README with expanded feature highlights including web support, packaging, mobile testing, extensibility, and accessibility
- Added inline counter app example to main documentation index with running instructions
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
Increases table of contents depth to 3 levels for better navigation |
docs/publish/ios.md |
Changes subsection headings from h3 to h4 for consistency with parent section structure |
docs/index.md |
Adds complete counter app example with installation and running instructions, removes TOC hiding |
docs/getting-started/testing-on-mobile.md |
Adds warning about app versions and changes prerequisites admonition type from danger to note |
docs/getting-started/running-app.md |
Removes Poetry-specific command examples, streamlining to uv and pip only |
docs/getting-started/installation.md |
Removes Poetry installation instructions and reorganizes prerequisites section |
docs/getting-started/create-flet-app.md |
Updates to reference generic project managers instead of Poetry specifically |
README.md |
Updates logo sizing, enhances tagline, expands feature highlights, and updates counter app example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Corrected 'built' to 'build' in the extensibility section for clarity.
Corrected wording to 'Build a cross-platform app' for clarity and improved grammar in the Python app description.
Summary by Sourcery
Update Flet documentation and README to reflect the 1.0 beta positioning and streamline getting-started guidance.
Documentation:
flet create.