Improve Reactor docs - #4872
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Documentation-only changes with one minor wrap/style nit noted; no functional or API risk identified.
Pull request overview
This PR refreshes the windows-reactor documentation to better explain Reactor's core mental model
(components + messages + declarative views) and to point readers at the most relevant samples and
workflows.
Changes:
- Rewrites the guide to introduce the component/message/view loop up front, with a complete first
component example and common UI patterns (layout, controlled input, keyed lists, background work). - Reorganizes “what to read next” into a focused sample index aligned with the new narrative.
- Updates the crate README’s guide blurb to match the revised guide topics and improves line wrapping.
File summaries
| File | Description |
|---|---|
| docs/crates/windows-reactor.md | Major guide rewrite: new structure, new examples, and updated “next steps” pointers. |
| crates/libs/reactor/readme.md | Adjusts wrapping and updates the guide description to match the new guide content. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+422
to
+424
| In a debug build, set `WINDOWS_REACTOR_TRACE=1` to print a reconciliation summary before each | ||
| nonempty component update is applied. The trace reports native property, topology, subscription, | ||
| creation, and destruction command counts. |
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.
No description provided.