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.

Sign up for GitHub

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

Jump to bottom

Generate documentation from the code #336

Open
rdiaz82 opened this issue Aug 10, 2020 · 1 comment
Open

Generate documentation from the code #336

rdiaz82 opened this issue Aug 10, 2020 · 1 comment
Labels
dev-experience Developer Experience documentation Improvements or additions to documentation good first issue Good for newcomers size: M Tasks where you have to change some files.

Comments

@rdiaz82
Copy link
Contributor

rdiaz82 commented Aug 10, 2020

Research about the generation of documentation from code using http://typedoc.org/ . If we try to apply it to the whole project we get some errors probably they are related to tsconfig.

A/C

  1. The website with the documentation can be created using typedoc
  2. The documentation creation is integrated into the CI/CD
@rdiaz82 rdiaz82 added documentation Improvements or additions to documentation good first issue Good for newcomers size: M Tasks where you have to change some files. labels Aug 10, 2020
@javiertoledo javiertoledo added the dev-experience Developer Experience label Dec 19, 2022
@Dilshad45333
Copy link

I am start working on it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
dev-experience Developer Experience documentation Improvements or additions to documentation good first issue Good for newcomers size: M Tasks where you have to change some files.
Projects
Booster Framework Roadmap
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
3 participants
@javiertoledo @rdiaz82 @Dilshad45333