Skip to content

Automatically generate the doc #200

Description

@bchamagne

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeatureNew feature request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions