01/docs
killian 9f77cf99a3
Merge branch 'main' into manufacturing-report
2024-09-06 11:29:40 -07:00
..
getting-started Refactor getting started documentation to improve clarity and reorganize sections for better reader flow. 2024-09-03 14:24:16 -04:00
hardware Merge branch 'main' into manufacturing-report 2024-09-06 11:29:40 -07:00
legal Move mobile privacy documentation from hardware/mobile to legal/privacy & update mint.json groupings to match the updated file hierarchy 2024-09-03 14:25:45 -04:00
logo Added docs 2024-03-11 14:42:31 -07:00
safety Safety documentation 2024-08-31 15:28:38 -07:00
software Update docs/software/installation.mdx to point to correct run instructions (/software/server/introduction) 2024-09-05 12:12:42 -04:00
troubleshooting Add troubleshooting guide for app stuck on 'Starting...' screen and clarify external device connection requirements in FAQ. 2024-09-05 12:40:04 -04:00
video_documentation Added documentation links for youtube videos explaining installation and usage 2024-03-26 14:24:11 -04:00
README.md 01.1 2024-08-25 17:51:22 -07:00
README_CN.md remove references to i.py 2024-07-10 14:47:19 -04:00
README_FR.md remove references to i.py 2024-07-10 14:47:19 -04:00
README_JA.md remove references to i.py 2024-07-10 14:47:19 -04:00
favicon.png Added docs 2024-03-11 14:42:31 -07:00
mint.json Merge branch 'main' into manufacturing-report 2024-09-06 11:29:40 -07:00
style.css Re-lint after rebase 2024-04-03 09:16:32 +02:00

README.md

Contribute to these docs

  • 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