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

Automatically generate the doc #200

Open
bchamagne opened this issue May 15, 2024 · 0 comments
Open

Automatically generate the doc #200

bchamagne opened this issue May 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation feature New feature request

Comments

@bchamagne
Copy link
Member

bchamagne commented May 15, 2024

Is your feature request related to a problem?

No response

Describe the solution you'd like

I think we could remove the doc from the readme and do everything with JSDoc (thanks to the work of @Rudy-Perrin).
It looks great:
Capture d’écran 2024-05-15 à 16 55 19
(I used npx typedoc src)

There's different alternatives, I used the first package I found.
Then we can add it to githubaction (or maybe a prehook?) to always be up to date

Additional context

No response

Epic

No response

@bchamagne bchamagne added documentation Improvements or additions to documentation feature New feature request labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature request
Projects
None yet
Development

No branches or pull requests

1 participant