-
Notifications
You must be signed in to change notification settings - Fork 203
Closed
Labels
enhancementNew feature or requestNew feature or requesttriageA new issue that needs triageA new issue that needs triage
Description
Package
Not package-specific
Describe the feature request
While reviewing #787 I noticed that much of the reference section in the docs is hand authored, including copying and pasting essentially what is code from the codebase. This is very labor intensive and will prove difficult to maintain.
I've had success using TypeDoc for this on other projects and converting it to markdown using typedoc plugin markdown for inclusion in docs.
This will require the inline comments in the codebase to be improved (or in many cases added) but that is good for the health of the codebase in general.
Describe the solution you'd like
- Add TSDoc comments to the next-drupal package in
packages/next-drupal - Add the
typedoc-plugin-markdownnpm package as a dependency to the application inwww - In the
wwwapp, configuretypedoc-plugin-markdownto generate API documentation in the directorywww/content/apibased on the next-drupal package.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requesttriageA new issue that needs triageA new issue that needs triage