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

docs: Add docs generation #43

Merged
merged 44 commits into from
Jan 27, 2025
Merged

docs: Add docs generation #43

merged 44 commits into from
Jan 27, 2025

Conversation

onnovisser
Copy link
Collaborator

@onnovisser onnovisser commented Jan 13, 2025

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:

  • run yarn gen:docs
  • add, commit and push docs to sdk repo
  • trigger a script that copies the docs into sdk-docs and opens a PR with the changes
    PR will need to be approved by team members

Example PR: centrifuge/sdk-docs#11

@onnovisser onnovisser added the alpha Include in alpha release label Jan 13, 2025
Copy link

Auto-bumped version for release, this cannot be the last commit as bots can't trigger the workflows to pass the PR checks

@onnovisser onnovisser changed the title Add docs generation docs: Add docs generation Jan 13, 2025
Copy link
Collaborator

@sophialittlejohn sophialittlejohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!! 🔥

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

Attention: Patch coverage is 54.71698% with 48 lines in your changes missing coverage. Please review.

Project coverage is 93.17%. Comparing base (da1e121) to head (c3c67a4).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/index.ts 0.00% 47 Missing ⚠️
src/PoolNetwork.ts 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #43      +/-   ##
==========================================
- Coverage   94.13%   93.17%   -0.97%     
==========================================
  Files          30       30              
  Lines        4265     4308      +43     
  Branches      443      444       +1     
==========================================
- Hits         4015     4014       -1     
- Misses        242      286      +44     
  Partials        8        8              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sophialittlejohn sophialittlejohn enabled auto-merge (squash) January 21, 2025 13:43
@sophialittlejohn sophialittlejohn merged commit c5bf908 into main Jan 27, 2025
4 of 5 checks passed
@sophialittlejohn sophialittlejohn deleted the generate-docs branch January 27, 2025 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alpha Include in alpha release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants