Skip to content

Refresh README and docs to reflect current facade state#136

Merged
jonathanpeppers merged 1 commit into
mainfrom
jonathanpeppers/update-docs-state
Jun 7, 2026
Merged

Refresh README and docs to reflect current facade state#136
jonathanpeppers merged 1 commit into
mainfrom
jonathanpeppers/update-docs-state

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Owner

A lot of tracked issues have shipped since these docs were last touched (#56 animation, #57/#102 effects, #58 text styling, #60 Navigation, #61 theme reads + Color value type, #62 state primitives + RememberSaveable, #63 Modifier surface, #65 Compose value types, #70/#100 Arrangement, #97 SuspendBridge, #121 drawer family facades, #122 TopAppBar branching, #133 parameterized MaterialTheme). The README, architecture doc, and sample READMEs still described the world from several months ago, so this refreshes them.

README.md

  • Soften the "27-line entire MainActivity.cs" claim. The actual MainActivity.cs is now a 1838-line kitchen-sink demo with tabs for every facade. The snippet stays as the canonical hello-world shape but the prose now points readers at samples/Jetchat for a single-screen real-app example.
  • Rebuild the "What's wrapped today" table with everything shipped since: Pager / FlowRow / Carousels / PullToRefreshBox / LazyStaggeredGrid, full Button + IconButton + FAB families, Text styling primitives, SecureTextField, ExposedDropdownMenu, DockedSearchBar, NavHost / NavController, Animation, Effects, expanded Modifier surface, Color value type + parameterized MaterialTheme + theme reads, SuspendBridge, expanded state-holder list.

docs/architecture.md

samples/README.md

samples/Jetchat/README.md

Not touched

docs/NOTES.md is intentionally untouched. The main README already labels it as historical Tier 1 notes, and most of its content is about per-binding setup that has since been deleted.

Many tracked issues have shipped since these docs were last touched —
update README, docs/architecture.md, samples/README.md, and the
Jetchat sample README to reflect what's actually in the repo today.

README.md:
- Soften the "27 lines is the entire MainActivity.cs" claim — the
  sample is now a tabbed kitchen-sink demo. Point readers at
  samples/Jetchat for a single-screen real-app example.
- Rebuild the "What's wrapped today" table: add Pager / FlowRow /
  BoxWithConstraints / LazyStaggeredGrid, Carousels,
  PullToRefreshBox, full Button + IconButton + FAB variants,
  Text styling primitives, SecureTextField, ExposedDropdownMenuBox,
  DockedSearchBar, NavHost / NavController, Animation
  (AnimatedVisibility / AnimatedContent / Crossfade), Effects
  (LaunchedEffect / DisposableEffect / SideEffect), expanded
  Modifier surface, Color value type + parameterized MaterialTheme
  + theme reads, SuspendBridge async path, full state-holder list.
- Update Status to mention the kitchen-sink demo and theme params.

docs/architecture.md:
- Add ComposeFacadeGenerator alongside ComposeBridgeGenerator and
  ComposeDefaultsGenerator (third generator).
- New "Compose value types" section covering Color / Dp / Sp /
  FontWeight / TextAlign and the ComposeValueTypes registry.
- Rewrite Known issues to call out theming reads (#61), effects
  (#57/#128), suspend bridges (#97), Compose Navigation (#60) as
  shipped, with the remaining caveats. Add a "Still missing
  (tracked)" list pointing at the open issues
  (#59 CompositionLocal, #64 drawing, #69 WindowInsets, #54/#103
  Expressive M3, drawer Open/Close suspend bridges).

samples/README.md:
- Drop closed issues (#51 / #53 / #58 / #61 / #62 / #63 / #65 /
  #70) from "Tracked facade gaps" and list them as a one-line
  "previously appeared here" summary instead. Add #59
  CompositionLocal to the open list.
- Restore the accidentally-truncated Attribution paragraph.

samples/Jetchat/README.md:
- Recast the "Hard-coded colors/typography" implementation notes
  as "feasible — not yet wired" now that
  MaterialTheme.CurrentColorScheme/Typography(composer) reads
  exist (#61 / PR #133).
- Update the hamburger-nav-icon note to reflect that the
  DrawerStateHolder wrapper landed (PR #131, Phase 10) and only
  the suspend Open()/Close() bridges remain.
- Wire the user-profile-screen omission to NavHost / NavController
  (now bound via #60).
- Move the asymmetric RoundedCornerShape omission from #65 to
  the still-open #64 drawing primitives.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 7, 2026 19:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This documentation-only PR refreshes four markdown files to reflect the many facade features that have shipped since the docs were last updated (covering PRs and issues: #56 animation, #57/#102/#128 effects, #58 text styling, #60 Navigation, #61 theming + Color, #62 state primitives, #63 Modifier surface, #65 Compose value types, #70/#100 Arrangement, #97 SuspendBridge, #121 drawer family facades, #122 TopAppBar branching, #133 parameterized MaterialTheme). No code changes are included.

Changes:

  • Rebuild the README's "What's wrapped today" table with all newly shipped composables, value types, animation, effects, async support, and navigation; soften the "27-line MainActivity.cs" claim to point readers at the kitchen-sink demo and the Jetchat sample.
  • Add the ComposeFacadeGenerator and "Compose value types" sections to docs/architecture.md, rewrite "Known issues" to mark theming/effects/suspend/navigation as shipped, and add a "Still missing (tracked)" section.
  • Clean up samples/README.md (move closed issues out of the tracking table, fix a stray #20 table row that was misplaced after the Attribution section) and update samples/Jetchat/README.md to recast shipped features as "feasible — not yet wired" with correct issue/PR cross-references.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
README.md Updated "What's wrapped today" table with all shipped facade families; softened the intro snippet claim; expanded the Status paragraph to mention the kitchen-sink demo.
docs/architecture.md Added ComposeFacadeGenerator to the generator list; new "Compose value types" section; shipped-feature bullets under "Known issues" (theming, effects, suspend, navigation); new "Still missing (tracked)" section.
samples/README.md Removed closed issues (#51/#53/#58/#61/#62/#63/#65/#70) from tracking table, added #59/#20, listed closed issues as a summary paragraph, fixed a stray #20 row after Attribution.
samples/Jetchat/README.md Recast theming/typography rows as "feasible — not yet wired"; updated DrawerStateHolder/NavHost references to reflect PRs #131/#60/#133; moved asymmetric Shape tracking from #65 to #64.

@jonathanpeppers jonathanpeppers merged commit 1572948 into main Jun 7, 2026
2 checks passed
@jonathanpeppers jonathanpeppers deleted the jonathanpeppers/update-docs-state branch June 7, 2026 19:18
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.

Add C# value types for Compose inline-class params (Color, Dp, Sp, FontWeight, TextAlign, Shape) and pass them through bridges

2 participants