01/docs
Mike Bird e7551438a8 getting start introduction draft 2024-03-12 21:45:20 -04:00
..
bodies new docs structure 2024-03-12 21:12:03 -04:00
client new docs structure 2024-03-12 21:12:03 -04:00
getting-started getting start introduction draft 2024-03-12 21:45:20 -04:00
logo Added docs 2024-03-11 14:42:31 -07:00
server new docs structure 2024-03-12 21:12:03 -04:00
services new docs structure 2024-03-12 21:12:03 -04:00
snippets 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
mint.json new docs structure 2024-03-12 21:12:03 -04: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