Skip to content

docs: Improve flame documentation structure, grammar, and accuracy#3827

Open
spydon wants to merge 9 commits intomainfrom
worktree-doc-fixes
Open

docs: Improve flame documentation structure, grammar, and accuracy#3827
spydon wants to merge 9 commits intomainfrom
worktree-doc-fixes

Conversation

@spydon
Copy link
Member

@spydon spydon commented Mar 1, 2026

Description

Addresses unchecked items from #2895:

  • Add introductory "why" paragraphs to each major documentation section, with links to related Flutter/game dev concepts
  • Split the monolithic components.md (1500+ lines) into focused pages under components/
  • Fix grammar, typos, and style issues across all doc/flame/ files
  • Replace deprecated gameRef with game and fix outdated Future? signature
  • Remove outdated Flutter 3.13 version reference
  • Replace all -- with proper punctuation

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

Closes: #2895

spydon and others added 9 commits March 1, 2026 22:10
- Add introductory "why" paragraphs to all major doc sections explaining
  the purpose of each topic and connecting it to Flutter/game dev concepts
- Split the 1536-line components.md into focused pages under components/
  (position, sprites, parallax, shapes, utility components)
- Update all cross-references to point to the new component pages
- Replace em dashes with standard punctuation throughout docs
- Fix prose lines to wrap at 100 chars and code comments at 80 chars

Addresses unchecked items 2, 3, and 4 from #2895.
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.

Documentation Improvements

1 participant