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

cloudflare-workers-and-pages bot commented Dec 24, 2025

Deploying flet-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6b6e5d7
Status:⚡️  Build in progress...

View logs

Copy link
Contributor

Copilot AI left a 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 uv and pip workflows
  • 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.
@FeodorFitsner FeodorFitsner merged commit 394d1b6 into main Dec 24, 2025
7 of 9 checks passed
@FeodorFitsner FeodorFitsner deleted the docs-beta branch December 24, 2025 21:45
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.

3 participants