🤖 Generated by the Daily AI Assistant
Part of the roadmap epic #167 (direction 2 — accurate, helpful docs).
Problem
The README does not read like the front door of a template repository:
- Wrong adoption framing. "🚀 Getting Started" tells the reader to install the package from NuGet (
dotnet add package <package-name>), and "📝 Usage" is generic dotnet new / dotnet sln boilerplate. But this repo is a GitHub template — the real entry point is the "Use this template" button, then renaming the Example project/namespace.
- Broken badge. The Test badge points to
…/actions/workflows/test.yaml, but there is no test.yaml in .github/workflows/ (the workflows are ci.yaml, publish.yaml, release.yaml, sync-labels.yaml, todos.yaml). PR validation runs via the org-required reusable workflow, not a repo-local test.yaml, so the badge renders no/“not found” status.
- Undocumented value. The README doesn't mention what the template actually gives you: the house defaults (
Nullable, AnalysisMode=All, TreatWarningsAsErrors, XML docs), the validation/CI model, the tag-driven publish-dotnet-library release flow, or the AI-maintenance setup (AGENTS.md + .claude/).
Proposed direction
- Rewrite "Getting Started" around the template-usage flow: "Use this template" → rename the
Example project/namespace/test project → dotnet build / dotnet test.
- Fix or remove the stale Test badge — point it at the actual validating workflow/check, or drop it if there is no repo-local workflow to badge.
- Add a short "What's included" section: the enforced house defaults, how PRs are validated, how releases/publishing work, and the AI-maintenance conventions.
- Align tone/structure with go-template#70's README enrichment so the two templates read consistently.
Acceptance criteria
- README describes a template repo (no "install from NuGet" framing for adoption).
- No broken badges (Test badge fixed or removed; other badges accurate).
- A new adopter can tell, from the README alone, what the scaffold provides and how to start.
Size
S — docs-only. Good first issue.
Part of the roadmap epic #167 (direction 2 — accurate, helpful docs).
Problem
The README does not read like the front door of a template repository:
dotnet add package <package-name>), and "📝 Usage" is genericdotnet new/dotnet slnboilerplate. But this repo is a GitHub template — the real entry point is the "Use this template" button, then renaming theExampleproject/namespace.…/actions/workflows/test.yaml, but there is notest.yamlin.github/workflows/(the workflows areci.yaml,publish.yaml,release.yaml,sync-labels.yaml,todos.yaml). PR validation runs via the org-required reusable workflow, not a repo-localtest.yaml, so the badge renders no/“not found” status.Nullable,AnalysisMode=All,TreatWarningsAsErrors, XML docs), the validation/CI model, the tag-drivenpublish-dotnet-libraryrelease flow, or the AI-maintenance setup (AGENTS.md+.claude/).Proposed direction
Exampleproject/namespace/test project →dotnet build/dotnet test.Acceptance criteria
Size
S — docs-only. Good first issue.