You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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-markdown npm package as a dependency to the application in www
In the www app, configure typedoc-plugin-markdown to generate API documentation in the directory www/content/api based on the next-drupal package.
The text was updated successfully, but these errors were encountered:
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
packages/next-drupal
typedoc-plugin-markdown
npm package as a dependency to the application inwww
www
app, configuretypedoc-plugin-markdown
to generate API documentation in the directorywww/content/api
based on the next-drupal package.The text was updated successfully, but these errors were encountered: