01/docs
Ben Xu 2f53be05db update livekit server and profile docs 2024-12-09 13:34:44 -08:00
..
assets Docs update 2024-09-11 21:26:15 -07:00
client Docs update 2024-09-11 21:58:42 -07:00
hardware Docs update 2024-09-11 22:16:36 -07:00
legal Docs update 2024-09-11 20:22:16 -07:00
logo Added docs 2024-03-11 14:42:31 -07:00
safety Safety documentation 2024-08-31 15:28:38 -07:00
server update livekit server and profile docs 2024-12-09 13:34:44 -08:00
setup Docs update 2024-09-11 22:16:36 -07:00
troubleshooting ESP32 docs fix 2024-09-09 16:39:47 -07: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
all_files_contents.txt Docs update 2024-09-11 21:58:42 -07:00
favicon.png Added docs 2024-03-11 14:42:31 -07:00
mint.json Docs update 2024-09-11 21:58:42 -07:00
style.css Docs update 2024-09-11 20:22:16 -07: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