next-drupal icon indicating copy to clipboard operation
next-drupal copied to clipboard

Generate API Documentation Via TypeDoc

Open backlineint opened this issue 1 year ago • 0 comments

Package

Not package-specific

Describe the feature request

While reviewing https://github.com/chapter-three/next-drupal/pull/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.

backlineint avatar Aug 28 '24 14:08 backlineint