[ziadantar90]

Requested by Ziad · project thread

What changed

README polish

• Centred header with a tagline, badges (CI, latest release, licence, Azure DevOps, PowerShell 7, Go) and a quick-links row.
• A four-row "why" table under the intro.
• "How it works" now uses a Mermaid flowchart (GitHub renders it) plus the numbered run steps, replacing the ASCII tree.
• New "Documentation" index table linking every guide.
• Removed the stale "Status: pre-1.0" note and the "(planned)" defaults in the configuration table; the breaking-changes callout now reads as an upgrade note.

Set up with an AI agent (new section, after the quick start)

• A copy-paste prompt, in a collapsible block, for an agent such as Claude Code. It asks for all inputs first, then works through numbered steps: Part 1 is the review stage (import, model, service connection, ADO access, variable group, rules file, pipeline, build validation, first-run approvals); Part 2 is the optional metrics API (providers, two-pass Bicep, setup-entra.sh, az acr build, grant-events-write.sh, metrics variable group, auth checks). It ends with a verification list and a teardown summary.
• It carries the R3 snags: the api://<appId> fallback, resource provider registration, no inline # comments (zsh), foundryTokenResource for classic Azure OpenAI, connecting the org to Entra before adding the SP, removing the auto-granted Contributor, importing into a new pullpicket repo, and not trusting a green stage without checking for "Failed to post comment".
• The agent stops for portal-only steps and opens a PR in the user's repo instead of pushing to the default branch.

CHANGELOG: an Unreleased "Added" entry.

Notes

• The release badge needs the repository to be public; while it is private, shields.io shows "repo not found".
• Docs only; no code or template changes.

---

Generated by Claude Code