♻️ Tidy up API reference docs.

xyflow / react-flow-docs

⚠️ This repo contains old versions of the React Flow website. The new repo is located at:

https://github.com/xyflow/web

MIT License

48 stars 596 forks source link

♻️ Tidy up API reference docs. #115

Closed hayleigh-dot-dev closed 1 year ago

hayleigh-dot-dev commented 1 year ago

Consistently report types as valid ts types.
Use ? to indicate optional props.
- Only document the default value when it is not undefined.
Update places where the simple function type was used in favour of the more specific type.

I think this should be straightforward to review, but it would great if you both could just do a quick pass and make sure everything is still sensible.

netlify[bot] commented 1 year ago

Deploy Preview for react-flow ready!

Name	Link
Latest commit	89ab7ebb11ef6b948c7a42abf5131aa6ec5d6076
Latest deploy log	https://app.netlify.com/sites/react-flow/deploys/645d26298ba3ba0008e031a0
Deploy Preview	https://deploy-preview-115--react-flow.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

moklick commented 1 year ago

This is a pretty good update 💯 Thanks!

xyflow / react-flow-docs

♻️ Tidy up API reference docs. #115

✅ Deploy Preview for react-flow ready!

Deploy Preview for react-flow ready!