Improve UI docs - #4875
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The updated docs include at least one Rust snippet that does not type-check (SwapChain::present return type) and a couple of consistency issues that should be corrected before merge.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR refreshes the getting-started documentation for the UI-focused crates to match the style and progression of the Reactor guide, emphasizing first-run workflows and “what to read next” pointers.
Changes:
- Reframes each guide around a “basic idea” mental model and a first complete workflow.
- Updates examples and narrative to focus on common lifetimes, event registrations, and hosting patterns.
- Reorganizes sample recommendations into “What to read next” tables with clearer “what it shows” descriptions.
File summaries
| File | Description |
|---|---|
| docs/crates/windows-webview.md | Reworks the guide into a first-host workflow plus focused sections for events, navigation, messaging, scripts, local hosting, and Reactor integration. |
| docs/crates/windows-composition.md | Rewrites the intro around retained visuals, adds a complete first program, clarifies core operations (tree, sizing, animation, shapes), and modernizes sample guidance. |
| docs/crates/windows-canvas.md | Reframes Canvas as immediate-mode drawing, adds a first Reactor-hosted example, and reorganizes common drawing workflows and sample pointers. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
These bring the other UI crates in line with the Reactor getting started guide.