-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs: Add docs generation #43
base: main
Are you sure you want to change the base?
Conversation
Auto-bumped version for release, this cannot be the last commit as bots can't trigger the workflows to pass the PR checks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!! 🔥
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #43 +/- ##
==========================================
- Coverage 94.09% 93.09% -1.00%
==========================================
Files 29 29
Lines 4095 4140 +45
Branches 425 426 +1
==========================================
+ Hits 3853 3854 +1
- Misses 234 278 +44
Partials 8 8 ☔ View full report in Codecov by Sentry. |
bb78d96
to
ef531bd
Compare
5d23742
to
095efe0
Compare
e0d853f
to
5b6fde1
Compare
31f98e1
to
c313385
Compare
4bf62b4
to
1c2f461
Compare
9b58170
to
d97b7f1
Compare
d7751c9
to
20843ed
Compare
9fff1be
to
53d1140
Compare
Description
Use Typedoc to generate docs in a way that can be easily consumed in the Slate documentation. Moves around a few types and makes sure types are exported, so Typedoc picks up on them.
#2571
Includes a Github Workflow for updating auto docs and triggered on push to main. It will:
yarn gen:docs
PR will need to be approved by team members
Example PR: centrifuge/sdk-docs#8