Skip to content

HOWTO: Package README files #349

@ycombinator

Description

@ycombinator

We should create a HOWTO document for package developers who want to write README.md files for their packages. It should cover things like the _dev/build/docs/README.md template, the generated README.md file, the various placeholders (e.g. event and fields) available in the README template and what they mean + where they pull their replacement contents from, etc.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions