Development workflow
5. Writing docs
For our documentation we use the amazing Mintlify, so you will need to have their CLI installed globally to be able to preview the docs:
With just that you can go ahead and run the following to get a preview of the docs
apps/docs
Check out Mintlify’s development guide for a few more interesting development tools.
Components
Mintlify uses mdx
to allow us to write docs in a composable ways. Because of
mdx
, we can build our own
components
but it’s always best to use the components Mintlify already provides us, so
always check up on this page of
their docs for documentation of their components.