FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: remove overhaul report and refresh runtime guides by owenthcarey · Pull Request #84 · pythonnative/pythonnative · GitHub

docs: remove overhaul report and refresh runtime guides - #84

Merged
owenthcarey merged 1 commit into
mainfrom
docs/current-runtime
Sep 6, 2026
Merged

owenthcarey merged 1 commit into
mainfrom
docs/current-runtime

Conversation

Copy link
Copy Markdown
Contributor

The docs exposed a one-time runtime overhaul report under Concepts and still described removed behavior in several guides and API docstrings. This cleanup makes the existing documentation describe the current runtime consistently.

  • Remove design/runtime-overhaul.md and its navigation entry. Keep profiling instructions and current limitations in the development workflow and architecture pages, and link complete example apps from the examples overview.
  • Correct the README, guides, and generated API descriptions for Yoga layout, host wheels versus mobile compilation, the shared application tree, bridge validation and threading, native lists, animation graphs, Android gestures, and browser preview differences.
  • Update the documentation style guide to keep current behavior in guides, release history in the changelog, and implementation progress and one-time validation in PRs. Keep the release recovery procedure reusable and remove incident-specific notes.
  • Correct the layout test example to use widths that divide evenly under Yoga's frame rounding.

The Python source edits are docstrings and comments only. Comparing the executable AST before and after confirmed no behavior changes in all 15 edited Python files. The docs: commit does not trigger a package release; the docs site deploys after merging, and the revised README reaches PyPI with the next package release.

Validation:

  • uv run --no-sync --group docs mkdocs build --strict
  • uv run --no-sync pytest -q
  • Ruff, Black, MyPy, and git diff --check
  • Executed the layout-engine, rendered-layout, and profiling examples; verified that the profiling example exports timing events and a rendered-component counter.
  • Checked the built pages, navigation, and search index: the removed report is absent, and the retained guidance is reachable.

owenthcarey merged commit 607e0c7 into main Sep 6, 2026
29 checks passed
owenthcarey deleted the docs/current-runtime branch September 6, 2026 05:57
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant


Back | FazBrowse Home | New Git URL