visdesignlab / upset2

UpSet - Visualizing Intersecting Sets
https://upset.multinet.app/
BSD 3-Clause "New" or "Revised" License
50 stars 7 forks source link

Add documentation via typedoc #313

Closed JakeWags closed 7 months ago

JakeWags commented 7 months ago

Does this PR close any open issues?

Closes none

Give a longer description of what this PR addresses and why it's needed

This PR restructures the upset-react package's component directory to be more clear. Additionally the PR adds documentation comment strings to most functions. These are preliminary and can/should be refined.

Docs are published to gh-pages on push to main.

Provide pictures/videos of the behavior before and after these changes (optional)

Are there any additional TODOs before this PR is ready to go?

TODOs:

netlify[bot] commented 7 months ago

Deploy Preview for upset2 ready!

Name Link
Latest commit 0b6f8e39bea97b9c369c80f85b15e65de3ecb834
Latest deploy log https://app.netlify.com/sites/upset2/deploys/65f345f6407d7100087baff9
Deploy Preview https://deploy-preview-313--upset2.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.