Repository navigation
Ship a starter README in every generated solution #79
Description
A generated solution only gets docs/RUN.md, so when someone pushes it to GitHub the front page is empty. A short starter README fixes that and points to the docs and AGENTS.md.
Phase 1: The README
- Add
template/README.mdto each template: the solution name (renamed bysourceName), what it is, how to run and test it, links to RUN.md, AGENTS.md and the docs site (Ship a starter README in generated solutions CleanMinimalApi#84, Ship a starter README in generated solutions CleanModelContextProtocol#64, Ship a starter README in generated solutions CleanGraphQLApi#63, Ship a starter README in generated solutions CleanWebApi#58) - Pack it as
content/README.mdintemplate/template.csprojand add it to the.slnxsolution items - Keep the template's own name out of every URL in it
- Update
template-authoringand the drift list if the file is shared (Check template/README.md in Shared Layers Drift #94)
Phase 2: Docs
- Add it to each
reference/project-structure.mdx(List README.md in the generated project structure leanmeancleanapps.github.io#27)
Checks: the build pipeline passes, Verify Template shows README.md in the generated solution, and Shared Layers Drift finds no differences.
Activity
Tidy the starter README's wording (#65)
Ship a starter README in generated solutions (#58)
Ship a starter README in generated solutions (#64)
Ship a starter README in generated solutions (#84)
stphnwlsh commentedon Nov 8, 2026
Handoff
Done: the starter README is in all five templates:
mainas 5a1936c, without a PR, with the punctuation fix in Tidy the starter README's wording CleanLambdaFunction#52Also #94 (drift list) and LeanMeanCleanApps/leanmeancleanapps.github.io#27 (project structure pages).
Checked:
mainand readREADME.md. It's titledWorksOnMyMachine.Movies, and its links todocs/RUN.md,AGENTS.mdandhttps://leanmeancleanapps.github.io/minimalapi/all resolve. It's listed in the.slnxsolution items, and nothing of the template's own name is left in it.Left: nothing.
Waiting on: nothing. One thing to know: Lambda's README went to
mainunsigned and unreviewed. The follow-up PR #52 is signed and reviewed.