Add Essentials.AI to main README and create product README#211
Conversation
Add the new Microsoft.Maui.Essentials.AI product to the main README's Products section, and create src/AI/README.md with package description, quick start, build instructions, and architecture overview. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add to both AGENTS.md and copilot-instructions.md that new products must have: - A product-level README.md packed into the NuGet (with PackRepoRootReadme=false to avoid duplicates) - An entry in the repo-root README.md under Products Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds repository-level documentation for the new Microsoft.Maui.Essentials.AI product introduced in #171, so the AI package is represented alongside the other MAUI Labs products and has its own product README.
Changes:
- Adds an
Essentials.AIproduct section to the rootREADME.md. - Introduces
src/AI/README.mdwith features, quick start, build notes, and architecture details. - Aligns Essentials.AI with the repo’s existing product-documentation structure.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
README.md |
Adds a high-level Essentials.AI product summary to the repo’s main product catalog. |
src/AI/README.md |
Adds the product-specific README covering setup, build guidance, and architecture. |
Align with NuGet README: add platform support table, requirements section, and experimental status warning. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
AddSingleton<IChatClient> (package only brings Abstractions, not full Extensions.AI helpers) - Clarify Windows build requires CI=true for prebuilt artifact path - Separate NL embeddings from Apple Intelligence (uses NaturalLanguage framework, not Foundation Models) - Reorder Mac Catalyst in requirements for clarity Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add content checklist to both AGENTS.md and copilot-instructions.md: name, features, platform matrix, quick start, packages, build instructions, architecture, requirements, and status warning. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Expert Code Review — PR #211Methodology: 3 independent reviewers with adversarial consensus 4 findings posted as inline comments (3 🟡 moderate, 1 🟢 minor) All findings are posted inline on the relevant lines — no overflow table needed. Discarded findings (single reviewer, no consensus)
CI Status
Test CoverageDocumentation-only PR — no code changes requiring test coverage.
Warning
|
![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 summary comment for full details.
Warning
⚠️ Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
learn.microsoft.com
To allow these domains, add them to the network.allowed list in your workflow frontmatter:
network:
allowed:
- defaults
- "learn.microsoft.com"See Network Configuration for more information.
Generated by Expert Code Review (auto) for issue #211 · ● 6.3M
- Add note to product README linking to NuGet consumer README - Fix AGENTS.md and copilot-instructions.md: clarify that NuGet README lives next to the csproj (not product root), and explain the two-README pattern (contributor vs consumer) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Following the merge of #171 (Microsoft.Maui.Essentials.AI), this adds the new product to the repo documentation.
Changes
README. Added Essentials.AI section under Products, between DevFlow and Getting Startedmdsrc/AI/README. New product README with features, quick start, package table, build instructions, and architecture overviewmdEvery other product (Cli, Comet, Go, DevFlow) has a section in the main README and a product-level README. This brings Essentials.AI in line.