01/docs
Mike Bird 64cc756260 Updated FAQ section with new accordion titles and content, removed redundant information and improved clarity on topics such as device connection, server running requirements, and API credit options. 2024-07-29 18:54:05 -04:00
..
getting-started Enhance CLI flags with more detailed descriptions and usage examples. 2024-07-22 16:33:17 -04:00
hardware **Added documentation for custom hardware integration with O1 server software** 2024-07-29 18:53:16 -04: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
snippets Added docs 2024-03-11 14:42:31 -07:00
software Added detailed component explanations, usage instructions, and contribution guidelines to `introduction.mdx` documentation. 2024-07-29 18:53:42 -04:00
troubleshooting Updated FAQ section with new accordion titles and content, removed redundant information and improved clarity on topics such as device connection, server running requirements, and API credit options. 2024-07-29 18:54:05 -04: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 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 "Refactor hardware documentation: Consolidate ESP32 setup instructions" 2024-07-22 17:35:40 -04: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