MirrorMirror
/
01
mirror of https://github.com/OpenInterpreter/01.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
01/docs
History
killian 6fb71dde41 Docs changes, minor fixes 2024-08-31 15:04:42 -07:00
..
getting-started Refactor documentation for server setup, including livekit and light servers, and add information about required dependencies for MacOS and Ubuntu, including PortAudio, FFmpeg, and CMake. 2024-08-30 19:19:43 -04:00
hardware Update documentation to include new Livekit and Light server setup guides, remove outdated run guide, and reflect changes to 01 platform introduction and hardware documentation. 2024-08-27 16:57:44 -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
safety Docs changes, minor fixes 2024-08-31 15:04:42 -07:00
software Refactor documentation for server setup, including livekit and light servers, and add information about required dependencies for MacOS and Ubuntu, including PortAudio, FFmpeg, and CMake. 2024-08-30 19:19:43 -04:00
troubleshooting Expanded documentation to include answers to common questions regarding communication encryption, third-party services used in exposing 01 servers, and clarify these for the users. 2024-08-22 10:10:55 -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 Refactor documentation for server setup, including livekit and light servers, and add information about required dependencies for MacOS and Ubuntu, including PortAudio, FFmpeg, and CMake. 2024-08-30 19:19:43 -04: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