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
Mike Bird fad65dadc2
Add troubleshooting guide for app stuck on 'Starting...' screen and clarify external device connection requirements in FAQ.
10 months ago
..
getting-started Refactor getting started documentation to improve clarity and reorganize sections for better reader flow. 10 months ago
hardware duplicate privacy policy to ensure reference doesn't break 10 months ago
legal Move mobile privacy documentation from hardware/mobile to legal/privacy & update mint.json groupings to match the updated file hierarchy 10 months ago
logo Added docs 1 year ago
safety Safety documentation 10 months ago
software Update docs/software/installation.mdx to point to correct run instructions (/software/server/introduction) 10 months ago
troubleshooting Add troubleshooting guide for app stuck on 'Starting...' screen and clarify external device connection requirements in FAQ. 10 months ago
video_documentation Added documentation links for youtube videos explaining installation and usage 1 year ago
README.md 01.1 10 months ago
README_CN.md remove references to i.py 12 months ago
README_FR.md remove references to i.py 12 months ago
README_JA.md remove references to i.py 12 months ago
favicon.png Added docs 1 year ago
mint.json Reorganize and add documentation for mobile apps, including a new community-built native iOS app and updated instructions for React Native apps. 10 months ago
style.css Re-lint after rebase 1 year 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