Skip to content

Conversation

@FeodorFitsner
Copy link
Contributor

@FeodorFitsner FeodorFitsner commented Dec 24, 2025

Summary by Sourcery

Update Flet documentation and README to reflect the 1.0 beta positioning and streamline getting-started guidance.

Documentation:

  • Refresh README messaging to emphasize Python-only, cross-platform app development and expand feature highlights such as web support, packaging, testing on mobile, extensibility, and accessibility.
  • Inline a concrete counter app example into the main docs index and show how to run it on desktop and web.
  • Simplify installation and running instructions by focusing on standard pip/uv workflows and removing Poetry-specific guidance.
  • Clarify project creation instructions to reference generic project managers instead of specific tools and warn about README/pyproject overwrites from flet create.
  • Add a work-in-progress notice for the mobile testing app versions and adjust admonition levels for prerequisites and notes.
  • Retitle certain iOS publishing subsections for consistency and improve table-of-contents depth in MkDocs configuration.

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.
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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

@cloudflare-workers-and-pages
Copy link

Deploying flet-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5b23497
Status: ✅  Deploy successful!
Preview URL: https://eeb8d355.flet-docs.pages.dev
Branch Preview URL: https://docs-beta.flet-docs.pages.dev

View logs

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