Refresh README and docs to reflect current facade state#136
Merged
Conversation
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>
There was a problem hiding this comment.
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
ComposeFacadeGeneratorand "Compose value types" sections todocs/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#20table row that was misplaced after the Attribution section) and updatesamples/Jetchat/README.mdto 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. |
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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 +
Colorvalue 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 parameterizedMaterialTheme). The README, architecture doc, and sample READMEs still described the world from several months ago, so this refreshes them.README.md
MainActivity.cs" claim. The actualMainActivity.csis 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 atsamples/Jetchatfor a single-screen real-app example.Colorvalue type + parameterizedMaterialTheme+ theme reads,SuspendBridge, expanded state-holder list.docs/architecture.md
ComposeFacadeGeneratoralongside the two generators previously documented (third generator in the pipeline).Color/Dp/Sp/FontWeight/TextAlignand theComposeValueTypesregistry.samples/README.md
samples/Jetchat/README.md
MaterialTheme.CurrentColorScheme(composer)/CurrentTypography(composer)exist.DrawerStateHolderlanded in Migrate drawer family to [ComposeFacade] (#121) #131 (Phase 10) and only the suspendOpen()/Close()bridges remain.NavHost/NavController(now bound via Bind Compose Navigation: NavHost, composable("route"), rememberNavController, navigate/popBackStack, deep links #60).RoundedCornerShapeomission from closed Add C# value types for Compose inline-class params (Color, Dp, Sp, FontWeight, TextAlign, Shape) and pass them through bridges #65 to still-open Bind drawing primitives: Canvas, Modifier.drawBehind/drawWithContent, DrawScope, Brush, Path, Shape factories #64 (drawing primitives).Not touched
docs/NOTES.mdis 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.