Skip to content

Improve API documentation style #7

@TyMick

Description

@TyMick

Reads too much like a story right now. Not that the story needs to go—that can stay in a "what's this good for" kind of section—but the API documentation should be cleaner. And ideally generated straight from the JSDoc annotations in the source code. It looks like jsdoc-to-markdown would be good for that.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions