microsoft / microsoft/typespec

tspd should have ability to inject specific section into readme

Open
#7,052 0 comments 0 reactions 0 assignees View on GitHub
feature triaged:core tspd
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

Right now, tspd will overwrite the entire readme.md file based on the options defined in $lib. It would be better if this appended the options (and any other docs) into the readme rather than overwriting. This would allow emitters to include more emitter-specific information in the readme that is not easily covered by tspd generation. Append vs overwrite could be an option in tspd.

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.