archethic-foundation / archethic-foundation/libjs
Automatically generate the doc
- Dominant language
- TypeScript
- Stars
- 19
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
### 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:
(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_
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the existing documentation in the README and the TypeScript sources under src, then run `npx typedoc src` to inspect the generated output. Decide which documentation should move out of the README and whether generation belongs in a GitHub Action or a pre-hook; done means the generated documentation is complete and kept up to date automatically.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100