Skip to content

Ship a starter README in every generated solution #79

Open
LeanMeanCleanApps/leanmeancleanapps.github.io
#27

Description

@stphnwlsh

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.md to each template: the solution name (renamed by sourceName), what it is, how to run and test it, links to RUN.md, AGENTS.md and the docs site
  • Pack it as content/README.md in template/template.csproj and add it to the .slnx solution items
  • Keep the template's own name out of every URL in it
  • Update template-authoring and the drift list if the file is shared

Phase 2: Docs

  • Add it to each reference/project-structure.mdx

Checks: the build pipeline passes, Verify Template shows README.md in the generated solution, and Shared Layers Drift finds no differences.

Activity

  1. added this to the 2026.12.01 milestone on Nov 6, 2026
  2. self-assigned this
    on Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions