Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate API Documentation Via TypeDoc #796

Open
backlineint opened this issue Aug 28, 2024 · 0 comments · May be fixed by #821
Open

Generate API Documentation Via TypeDoc #796

backlineint opened this issue Aug 28, 2024 · 0 comments · May be fixed by #821
Labels
enhancement New feature or request triage A new issue that needs triage

Comments

@backlineint
Copy link
Contributor

backlineint commented Aug 28, 2024

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-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.
@backlineint backlineint added enhancement New feature or request triage A new issue that needs triage labels Aug 28, 2024
backlineint added a commit to backlineint/next-drupal that referenced this issue Nov 19, 2024
@backlineint backlineint linked a pull request Nov 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage A new issue that needs triage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant