You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
01/docs
killian 9f77cf99a3
Merge branch 'main' into manufacturing-report
4 months ago
..
getting-started Refactor getting started documentation to improve clarity and reorganize sections for better reader flow. 4 months ago
hardware Merge branch 'main' into manufacturing-report 4 months ago
legal Move mobile privacy documentation from hardware/mobile to legal/privacy & update mint.json groupings to match the updated file hierarchy 4 months ago
logo Added docs 10 months ago
safety Safety documentation 4 months ago
software Update docs/software/installation.mdx to point to correct run instructions (/software/server/introduction) 4 months ago
troubleshooting Add troubleshooting guide for app stuck on 'Starting...' screen and clarify external device connection requirements in FAQ. 4 months ago
video_documentation Added documentation links for youtube videos explaining installation and usage 10 months ago
README.md 01.1 5 months ago
README_CN.md remove references to i.py 6 months ago
README_FR.md remove references to i.py 6 months ago
README_JA.md remove references to i.py 6 months ago
favicon.png Added docs 10 months ago
mint.json Merge branch 'main' into manufacturing-report 4 months ago
style.css Re-lint after rebase 9 months ago

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