JoshuaKGoldberg / JoshuaKGoldberg/create-typescript-app

🚀 Feature: Allow README.mds to start "Usage" section with an h2 other than "Usage"

Open
#2,144 0 comments 0 reactions 0 assignees View on GitHub
status: accepting prs type: feature
Dominant language
TypeScript
Stars
1.4k
Forks
89
Avg merge
1m
Merged PRs (30d)
3

Description

### Feature Request Checklist

- [x] I have pulled the latest `main` branch of the repository.
- [x] I have [searched for related issues](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aissue) and found none that matched my issue.

### Overview

Right now, `blockREADME` assumes generated README.md files will have a `## Usage` h2:

https://github.com/JoshuaKGoldberg/create-typescript-app/blob/6bd31ee9e7f5ad0a3ad3964537f1047562e200ac/src/blocks/blockREADME.ts#L59-L63

That's true for most of my personal repos, but not all of them (see: https://github.com/JoshuaKGoldberg/prune-github-notifications/pull/201/files#r2028676849) - and certainly not everybody else's in the world. `## Usage` should not be assumed to exist.

Feature request: that `## Usage` heading should be part of `options.documentation.readme.usage`. Running `npx create-typescript-app` in transition mode should not add a `## Usage` heading if one does not exist already.

### Additional Info

🎁

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.