-
Notifications
You must be signed in to change notification settings - Fork 534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs edit #300
Merged
Merged
Docs edit #300
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c05fbd6
Refactor getting started documentation to improve clarity and reorgan…
MikeBirdTech 3b8e3cf
Move mobile privacy documentation from hardware/mobile to legal/priva…
MikeBirdTech 23568a9
Reorganize and add documentation for mobile apps, including a new com…
MikeBirdTech f9cf17a
Update mobile download documentation to include iOS and Android secti…
MikeBirdTech c718593
duplicate privacy policy to ensure reference doesn't break
MikeBirdTech c6e7be0
Modify server documentation to correct Livekit Server's URL for bette…
MikeBirdTech 1468a92
Enhance Livekit server documentation to include additional features, …
MikeBirdTech 76b8dc8
Update docs/software/installation.mdx to point to correct run instruc…
MikeBirdTech fad65da
Add troubleshooting guide for app stuck on 'Starting...' screen and c…
MikeBirdTech File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: "Community Apps" | ||
description: "Apps built by the community" | ||
--- | ||
|
||
## Native iOS app by [eladekkal](https://github.com/eladdekel). | ||
|
||
To run it on your device, you can either install the app directly through the current TestFlight [here](https://testflight.apple.com/join/v8SyuzMT), or build from the source code files in Xcode on your Mac. | ||
|
||
### Instructions | ||
|
||
- [Install 01 software](/software/installation) on your machine | ||
|
||
- In Xcode, open the 'zerooone-app' project file in the project folder, change the Signing Team and Bundle Identifier, and build. | ||
|
||
### Using the App | ||
|
||
To use the app there are four features: | ||
|
||
1. The speak "Button" | ||
|
||
Made to emulate the button on the hardware models of 01, the big, yellow circle in the middle of the screen is what you hold when you want to speak to the model, and let go when you're finished speaking. | ||
|
||
2. The settings button | ||
|
||
Tapping the settings button will allow you to input your websocket address so that the app can properly connect to your computer. | ||
|
||
3. The reconnect button | ||
|
||
The arrow will be RED when the websocket connection is not live, and GREEN when it is. If you're making some changes you can easily reconnect by simply tapping the arrow button (or you can just start holding the speak button, too!). | ||
|
||
4. The terminal button | ||
|
||
The terminal button allows you to see all response text coming in from the server side of the 01. You can toggle it by tapping on the button, and each toggle clears the on-device cache of text. |
6 changes: 2 additions & 4 deletions
6
docs/hardware/mobile/android.mdx → docs/hardware/mobile/development.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: "Download" | ||
description: "How to get your 01 mobile app" | ||
--- | ||
|
||
Using your phone is a great way to control 01. There are multiple options available. | ||
|
||
<CardGroup cols={2}> | ||
<Card title="iOS" icon="apple"> | ||
Coming soon | ||
</Card> | ||
<Card title="Android" icon="android"> | ||
Coming soon | ||
</Card> | ||
</CardGroup> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
--- | ||
title: "Privacy Policy" | ||
--- | ||
|
||
Last updated: August 8th, 2024 | ||
|
||
## 1. Introduction | ||
|
||
Welcome to the 01 App. We are committed to protecting your privacy and providing a safe, AI-powered chat experience. This Privacy Policy explains how we collect, use, and protect your information when you use our app. | ||
|
||
## 2. Information We Collect | ||
|
||
### 2.1 When Using Our Cloud Service | ||
|
||
If you choose to use our cloud service, we collect and store: | ||
|
||
- Your email address | ||
- Transcriptions of your interactions with our AI assistant | ||
- Any images you send to or receive from the AI assistant | ||
|
||
### 2.2 When Using Self-Hosted Server | ||
|
||
If you connect to your own self-hosted server, we do not collect or store any of your data, including your email address. | ||
|
||
## 3. How We Use Your Information | ||
|
||
We use the collected information solely for the purpose of providing and improving our AI chat service. This includes: | ||
|
||
- Facilitating communication between you and our AI assistant | ||
- Improving the accuracy and relevance of AI responses | ||
- Analyzing usage patterns to enhance user experience | ||
|
||
## 4. Data Storage and Security | ||
|
||
We take appropriate measures to protect your data from unauthorized access, alteration, or destruction. All data is stored securely and accessed only by authorized personnel. | ||
|
||
## 5. Data Sharing and Third-Party Services | ||
|
||
We do not sell, trade, or otherwise transfer your personally identifiable information to outside parties. This does not include trusted third parties who assist us in operating our app, conducting our business, or servicing you, as long as those parties agree to keep this information confidential. | ||
|
||
We may use third-party services for analytics and app functionality. These services may collect anonymous usage data to help us improve the app. | ||
|
||
## 6. Data Retention and Deletion | ||
|
||
We retain your data for as long as your account is active or as needed to provide you services. If you wish to cancel your account or request that we no longer use your information, please contact us using the information in Section 11. | ||
|
||
## 7. Your Rights | ||
|
||
You have the right to: | ||
|
||
- Access the personal information we hold about you | ||
- Request correction of any inaccurate information | ||
- Request deletion of your data from our systems | ||
|
||
To exercise these rights, please contact us using the information provided in Section 11. | ||
|
||
## 8. Children's Privacy | ||
|
||
Our app is not intended for children under the age of 13. We do not knowingly collect personal information from children under 13. If you are a parent or guardian and you are aware that your child has provided us with personal information, please contact us. | ||
|
||
## 9. International Data Transfer | ||
|
||
Your information, including personal data, may be transferred to — and maintained on — computers located outside of your state, province, country or other governmental jurisdiction where the data protection laws may differ from those in your jurisdiction. | ||
|
||
## 10. Changes to This Privacy Policy | ||
|
||
We may update our Privacy Policy from time to time. We will notify you of any changes by posting the new Privacy Policy on this page and updating the "Last updated" date. | ||
|
||
## 11. Contact Us | ||
|
||
If you have any questions about this Privacy Policy, please contact us at: | ||
|
||
Email: help@openinterpreter.com | ||
|
||
## 12. California Privacy Rights | ||
|
||
If you are a California resident, you have the right to request information regarding the disclosure of your personal information to third parties for direct marketing purposes, and to opt-out of such disclosures. As stated in this Privacy Policy, we do not share your personal information with third parties for direct marketing purposes. | ||
|
||
## 13. Cookies and Tracking | ||
|
||
Our app does not use cookies or web tracking technologies. | ||
|
||
## 14. Consent | ||
|
||
By using the 01 App, you consent to this Privacy Policy. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, I love all these links/resources