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

refactor!: move from apidoc to apidoc-light #384

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

cdcabrera
Copy link
Owner

@cdcabrera cdcabrera commented Sep 7, 2024

What's included

  • refactor!: move from apidoc to apidoc-light

Notes

  • alternative to changing parsers, retain the apidoc parser with apidoc-light
  • still loses the ability to serve the generated docs when compared to changing the parser
    • nice part is it retains the ability to scan multiple file comment types vs comment-parser

How to test

Example

...

Updates issue/story

ongoing

@cdcabrera cdcabrera changed the title refactor: move from apidoc to apidoc-light refactor!: move from apidoc to apidoc-light Sep 7, 2024
* cli, docs option removed
* apidocBuild, light only allows dryRun
* index, remove express served docs path
@cdcabrera cdcabrera added the refactor no quite performance, not quite broken, just different label Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor no quite performance, not quite broken, just different
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant