Refresh README onboarding and doctor fix coverage#315
Conversation
Prioritize MAUI CLI and DevFlow as the primary entry points, clarify doctor --fix as the setup path, and improve product discovery for consumers and agents. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Refreshes the repository onboarding docs to emphasize the MAUI CLI and DevFlow as the primary entry points, while keeping other products discoverable via a concise catalog and clarifying agent/MCP/skills expectations.
Changes:
- Reworks the repo-root README to lead with
maui doctor --fix, DevFlow onboarding, and an explicit product catalog. - Adds clearer guidance for DevFlow CLI vs DevFlow Agent, local agent skills, and MCP server usage.
- Updates the CLI README quick start to install the prerelease global tool.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/Cli/README.md |
Updates quick start install command to include --prerelease. |
README.md |
Reorganizes onboarding around MAUI CLI + DevFlow, adds product catalog and AI-agent guidance. |
| /plugin install dotnet-maui@dotnet-maui-labs | ||
| maui devflow init | ||
| maui devflow ui tree | ||
| maui devflow ui screenshot -o screenshot.png |
Cover the doctor --fix command path with a fake doctor service so auto-fix selection, post-fix reruns, platform-scoped checks, and final exit codes are verified without mutating the host machine. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jfversluis
changed the title
Expert Code Review — PR #315Methodology: 3 independent reviewers with adversarial consensus 4 findings posted as inline comments (3 moderate, 1 minor)
CI status: Test coverage: N/A — documentation-only change, no tests needed. No findings were discarded — all initially disputed findings (2–4) achieved consensus via follow-up evaluation.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Expert Code Review: 4 findings posted inline (3 moderate, 1 minor). See the lean summary comment for full details and methodology.
Generated by Expert Code Review (auto) for issue #315 · ● 8M
| | **Comet** | Experimental MVU UI framework for .NET MAUI: an alternative to XAML using C# fluent UI and reactive state | [`src/Comet/README.md`](src/Comet/README.md) | | ||
| | **Go** | Single-file Comet app prototyping with a server and companion app | [`src/Go/README.md`](src/Go/README.md) | | ||
| | **Essentials.AI** | On-device AI APIs for MAUI via `Microsoft.Extensions.AI` abstractions | [`src/AI/README.md`](src/AI/README.md) | | ||
| | **AI Extensions** | Source-generated AI tool bindings from decorated C# methods and property accessors | [`src/AIExtensions/README.md`](src/AIExtensions/README.md) | |
There was a problem hiding this comment.
🟢 MINOR · Consensus: 2/3 reviewers (validated via follow-up)
The old README linked directly to samples/AIExtensions.Sample.Garden/README.md for runnable usage examples. This restructure removes that direct link — users must now navigate through src/AIExtensions/README.md to find samples, adding a discoverability hop.
Suggestion: Consider adding a sample link in src/AIExtensions/README.md if not already present, or appending , [sample](samples/AIExtensions.Sample.Garden/README.md) to this row's "Start here" column.
| /plugin install dotnet-maui@dotnet-maui-labs | ||
| maui devflow init | ||
| maui devflow ui tree | ||
| maui devflow ui screenshot -o screenshot.png |
There was a problem hiding this comment.
🟡 MODERATE · Consensus: 2/3 reviewers
The -o shorthand does not exist on the screenshot command. The CLI only registers --output (no -o alias) in DevFlowCommands.cs. Copy-pasting this example will produce an "unrecognized option" error.
Suggestion: maui devflow ui screenshot --output screenshot.png
| | --- | --- | | ||
| | Inspect the MAUI visual tree | `maui devflow ui tree` | | ||
| | Tap, fill, scroll, resize, and assert UI state | `maui devflow ui --help` | | ||
| | Capture screenshots or recordings | `maui devflow ui screenshot` / `maui devflow recording start` | |
There was a problem hiding this comment.
🟡 MODERATE · Consensus: 3/3 reviewers (validated via follow-up)
Slash-separating maui devflow ui screenshot / maui devflow recording start in one table cell implies both share the maui devflow ui prefix. A user may try maui devflow ui recording start, which will fail — recording is a direct subcommand of maui devflow, not maui devflow ui.
Suggestion: Split into two table rows to avoid implying a shared command hierarchy.
| ```bash | ||
| # Install via Copilot CLI | ||
| /plugin marketplace add dotnet/maui-labs | ||
| /plugin install dotnet-maui@dotnet-maui-labs | ||
| maui devflow init |
There was a problem hiding this comment.
🟡 MODERATE · Consensus: 3/3 reviewers (validated via follow-up)
Placing maui devflow init first in this sequence implies it is a prerequisite for ui tree, ui screenshot, and mcp. In reality, init installs local workspace/IDE skills and is independent of the in-app DevFlow Agent that the other commands require. The preceding paragraph says "Run your app with the DevFlow Agent registered," but the code block conflates an optional skill-install step with runtime agent commands.
Suggestion: Either reorder so init comes last (it's optional/independent), or separate the block into "one-time setup" vs. "agent workflow" with a brief note.
Summary
maui doctor --fixas the easiest MAUI environment setup pathmaui doctor --fixauto-fix selection, post-fix reruns, platform-scoped checks, and exit-code behaviorValidation
./.dotnet/dotnet test src/Cli/Microsoft.Maui.Cli.UnitTests/ --logger "console;verbosity=minimal"Follow-up
maui doctor --fixon macOS and Windows to prove it can be documented as the recommended cross-platform setup path