seadanda / shuttle-docs

Shuttle Docs

Contributing

If you found an error in our docs, or you simply want to make them better, contributions are always appreciated!

Our docs are powered by mintlify. To run them for local development:

Install their cli:

NOTE: This requires Node v19

npm i -g mintlify
npm i -g yarn
mintlify install

And from the root of the repository, run:

mintlify dev

Contribution docs

Changes to community/contribute.mdx should be made in the main repo, since they will be automatically implemented here by the .github/workflows/replicate.yml workflow.