Skip to content

Simplify README install guidance#210

Draft
Redth wants to merge 1 commit into
mainfrom
redth/simplify-installs
Draft

Simplify README install guidance#210
Redth wants to merge 1 commit into
mainfrom
redth/simplify-installs

Conversation

@Redth
Copy link
Copy Markdown
Member

@Redth Redth commented May 1, 2026

These READMEs currently lead with package lists and setup details, which makes the first steps feel heavier than necessary. This PR moves the simplest install path to the top while preserving manual setup and package reference details below for readers who need them.

Summary

  • Add a root Fastest install path for installing the maui CLI, running maui doctor, using maui android install, inspecting Apple tooling on macOS, and initializing DevFlow.
  • Rewrite the DevFlow README lead section around CLI install, maui devflow init, adding the in-app agent package, debug registration, and first connection commands.
  • Keep manual XML package references, CLI install details, and package tables below the quick path sections.

Testing

Not run; documentation-only change.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Expert Code Review — PR #210

Methodology: 3 independent reviewers with adversarial consensus

Result: 2 findings posted as inline comments (1 moderate, 1 minor)

Findings Summary

# Severity Consensus File Line Finding
1 🟡 Moderate 2/3 initial src/DevFlow/README.md 48 -o flag does not exist for maui devflow ui screenshot; should be --output
2 🟢 Minor 2/3 after follow-up src/DevFlow/README.md 76 Duplicated MauiProgram.cs registration block risks future drift

CI Status

  • license/cla — passed
  • activation — passed
  • 🔄 build / build (windows-latest) — in progress
  • 🔄 agent — in progress

Test Coverage

PR is documentation-only (2 README files). No tests required.

Discarded Findings

None — all flagged findings reached consensus.


Generated by Expert Code Review · 3 independent reviewers with adversarial consensus

Generated by Expert Code Review (auto) for issue #210 · ● 4.5M ·

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Expert Code Review: 2 findings posted inline. See the lean summary comment for full details.

Generated by Expert Code Review (auto) for issue #210 · ● 4.5M

Comment thread src/DevFlow/README.md
```bash
maui devflow wait
maui devflow ui tree
maui devflow ui screenshot -o screenshot.png
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 MODERATE · 2/3 consensus

-o is not a registered alias for the --output option on maui devflow ui screenshot (only --output is defined in DevFlowCommands.cs). A user copying this verbatim will get a parse error.

Suggested change
maui devflow ui screenshot -o screenshot.png
maui devflow ui screenshot --output screenshot.png

Comment thread src/DevFlow/README.md
@@ -44,18 +76,17 @@ public static MauiApp CreateMauiApp()
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 MINOR · 2/3 consensus (after follow-up)

This MauiProgram.cs registration block (lines 63–77) is now identical to the one in the "Fastest path" section above (lines 27–41). Two full copies increases the risk of future drift if one is updated without the other. Consider replacing this copy with a short cross-reference: "See the registration snippet in Fastest path above."

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.

1 participant