01/docs
killian 9a68fad329 Added docs 2024-03-11 14:42:31 -07:00
..
01os Added docs 2024-03-11 14:42:31 -07:00
guides Added docs 2024-03-11 14:42:31 -07:00
logo Added docs 2024-03-11 14:42:31 -07:00
snippets Added docs 2024-03-11 14:42:31 -07:00
technical-instructions Added docs 2024-03-11 14:42:31 -07:00
README.md Added docs 2024-03-11 14:42:31 -07:00
favicon.png Added docs 2024-03-11 14:42:31 -07:00
introduction.mdx Added docs 2024-03-11 14:42:31 -07:00
mint.json Added docs 2024-03-11 14:42:31 -07:00
setup.mdx Added docs 2024-03-11 14:42:31 -07:00
style.css Added docs 2024-03-11 14:42:31 -07:00

README.md

01OS

Contribute

  • Clone this repo
  • install mintlify CLI
  • run mintlify in project directory to get preview of docs
  • make changes
  • push changes

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

Troubleshooting

  • Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
  • Page loads as a 404 - Make sure you are running in a folder with mint.json