01/docs
Henry Fontanier 2607b9ce8b
Update introduction.mdx
The `cd` commands assumes the user is already inside of the `01` directory (the repo's root), which is not likely to be the case as the previous command clones the repository into the current working directory.
2024-06-24 20:37:40 +02:00
..
bodies 01 light setup docs 2024-03-20 16:53:34 -04:00
client Re-lint after rebase 2024-04-03 09:16:32 +02:00
getting-started Update introduction.mdx 2024-06-24 20:37:40 +02:00
legal Update fulfillment-policy.mdx 2024-05-16 11:24:29 -07:00
logo Added docs 2024-03-11 14:42:31 -07:00
server Re-lint after rebase 2024-04-03 09:16:32 +02:00
services tts option docs 2024-03-20 16:47:09 -04:00
snippets Added docs 2024-03-11 14:42:31 -07:00
video_documentation Added documentation links for youtube videos explaining installation and usage 2024-03-26 14:24:11 -04:00
README.md Added docs 2024-03-11 14:42:31 -07:00
README_CN.md Update location of the kernel reference 2024-06-04 11:06:37 +03:00
README_FR.md Update French README 2024-04-01 11:42:00 +02:00
README_JA.md Update README_JA.md 2024-04-16 15:51:15 +09:00
favicon.png Added docs 2024-03-11 14:42:31 -07:00
mint.json fulfillment policy 2024-04-08 18:00:05 -07:00
style.css Re-lint after rebase 2024-04-03 09:16:32 +02: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