Skip to content

chore: update docs to follow organized structure #2552

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
{
"group": "Get Started",
"pages": [
"docs/get_started/introduction",
"docs/get_started/Flash_device",
"getstartedwithomi"
"docs/get-started/introduction",
"docs/get-started/flash-device",
"get-started-with-omi"
]
},
{
Expand All @@ -24,52 +24,52 @@
{
"group": "Apps",
"pages": [
"docs/developer/apps/Introduction",
"docs/developer/apps/PromptBased",
"docs/developer/apps/Integrations",
"docs/developer/apps/AudioStreaming",
"docs/developer/apps/Import",
"docs/developer/apps/Submitting",
"docs/developer/apps/Oauth",
"docs/developer/apps/Notifications"
"docs/developer/apps/introduction",
"docs/developer/apps/prompt-based",
"docs/developer/apps/integrations",
"docs/developer/apps/audio-streaming",
"docs/developer/apps/import",
"docs/developer/apps/submitting",
"docs/developer/apps/oauth",
"docs/developer/apps/notifications"
]
},
"docs/developer/AppSetup",
"docs/developer/app-setup",
{
"group": "Backend",
"pages": [
"docs/developer/backend/Backend_Setup",
"docs/developer/backend/backend_deepdive",
"docs/developer/backend/StoringMemory",
"docs/developer/backend/backend-setup",
"docs/developer/backend/backend-deepdive",
"docs/developer/backend/storing-memory",
"docs/developer/backend/transcription",
"docs/developer/backend/memory_embeddings",
"docs/developer/backend/memory-embeddings",
"docs/developer/backend/postprocessing"
]
},
{
"group": "Firmware",
"pages": [
"docs/developer/firmware/Compile_firmware"
"docs/developer/firmware/compile-firmware"
]
},
{
"group": "SDK",
"pages": [
"docs/developer/sdk/sdk",
"docs/developer/sdk/python",
"docs/developer/sdk/ReactNative",
"docs/developer/sdk/react-native",
"docs/developer/sdk/swift"
]
},
"docs/developer/Protocol",
"docs/developer/Contribution",
"docs/developer/MCP",
"docs/developer/protocol",
"docs/developer/contribution",
"docs/developer/mcp",
{
"group": "Audio & Testing",
"pages": [
"docs/developer/savingaudio",
"docs/developer/AudioStreaming",
"docs/developer/DevKit2Testing"
"docs/developer/saving-audio",
"docs/developer/audio-streaming",
"docs/developer/devkit2-testing"
]
}
]
Expand Down
111 changes: 0 additions & 111 deletions docs/docs/assembly/Build_the_device.mdx

This file was deleted.

90 changes: 90 additions & 0 deletions docs/docs/assembly/build-the-device.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: "Building the Device"
description: "Follow this step-by-step guide to build your own OMI device"
---

## Assembly Instructions

<Steps>
<Step title="Prepare the Components">
1. Ensure you've purchased all required components from the [Buying Guide](https://docs.omi.me/docs/assembly/Buying_Guide).
2. Download and print the case using the provided `.stl` file: [Case Design](https://github.com/BasedHardware/omi/tree/main/omi/hardware/triangle%20v1).
* If you don't have access to a 3D printer, use a 3D printing service or check [Makerspace](https://makerspace.com/) for printing locations.

![components](/images/docs/assembly/images/latest_assembly/components.png)
</Step>

<Step title="Cut the Black Wire">
Cut the black wire approximately **2/3" from the base**.

![battery](/images/docs/assembly/images/latest_assembly/1.png)
</Step>

<Step title="Strip the Wire Ends">
Remove a small portion of insulation from both ends of the cut wire using a wire stripper.

* Use the *28 AWG* notch for best results.

![wire](/images/docs/assembly/images/latest_assembly/2.png)
</Step>

<Step title="Solder the Components">
Follow the soldering diagram to connect the battery to the board.

![soldering](/images/docs/assembly/images/latest_assembly/3.png)
</Step>

<Step title="Secure the Switch">
Insert the switch securely into the battery connector.

![battery](/images/docs/assembly/images/latest_assembly/4.png)
![electronics](/images/docs/assembly/images/latest_assembly/electronics.png)
![case](/images/docs/assembly/images/latest_assembly/case.png)
</Step>

<Step title="Assemble the Battery and Board">
Place the battery and board into the 3D-printed case.

![case](/images/docs/assembly/images/latest_assembly/5.png)
</Step>

<Step title="Insert the Switch">
Position the switch into the notch next to the USB-C slot.

![notch](/images/docs/assembly/images/latest_assembly/6.png)
</Step>

<Step title="Manage the Wires">
Twist the longer red wire gently to help organize it within the case.

![twist](/images/docs/assembly/images/latest_assembly/7.png)
</Step>

<Step title="Curl the Wire">
Carefully curl the twisted wire and place it to the side to ensure it fits within the case.

![twist](/images/docs/assembly/images/latest_assembly/8.png)
</Step>

<Step title="Attach the Lid">
Align the lid with the case using the ridges as a guide and snap it into place.

![lid](/images/docs/assembly/images/latest_assembly/9.png)
</Step>

<Step title="Secure the Case">
Apply even pressure around the edges to ensure the seams snap securely into place.

![seams](/images/docs/assembly/images/latest_assembly/10.png)
</Step>
</Steps>

### Charging Instructions

**Important:**
* OMI can only charge when it is powered on.
* The device will not charge if powered off.

## Congratulations!

You now have a fully assembled and functional OMI device! Enjoy exploring its features and capabilities.
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ description: "Please note that availability and prices may vary by region."
| **Wires** | - [Various options on Amazon US](https://www.amazon.com/dp/B09X4629C1) | **Varies** |
| **Case** | - [3D-print design available on GitHub](https://github.com/BasedHardware/Omi/tree/main/Omi/hardware/triangle%20v1) | **Varies** |

***

## Notes:[​](#notes "Direct link to Notes:")
## Notes:

1. The provided links are third-party providers; we do not guarantee product availability or quality.
2. Pricing is approximate and may vary depending on your location and shipping fees.
20 changes: 6 additions & 14 deletions docs/docs/assembly/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,31 @@ title: "Build Your Own OMI Device"
description: "As an open-source community, we empower enthusiasts to create their own OMI devices. This guide focuses on building the **Developer Kit 1**, as the **Developer Kit 2** relies on a custom PCB and is not suited for DIY assembly."
---

***

## Is This Guide for You?[​](#is-this-guide-for-you "Direct link to Is This Guide for You?")
## Is This Guide for You?

Building your own OMI device can be a rewarding experience but is best suited for individuals with **advanced knowledge** of soldering and PCBs. If you're confident in your skills and ready for the challenge, this guide will help you get started.

***

## Is It Cheaper?[​](#is-it-cheaper "Direct link to Is It Cheaper?")
## Is It Cheaper?

While building your own OMI device is a great learning experience, it may not always be significantly cheaper than purchasing one directly from our [Shop](https://omi.me). The cost depends on the availability of parts in your region, shipping fees, and access to specialized tools.

If cost savings are your main goal, consider comparing the price of parts and tools against the price in our shop before deciding.

***
## Requirements

## Requirements[​](#requirements "Direct link to Requirements")

### Skills Needed:[​](#skills-needed "Direct link to Skills Needed:")
### Skills Needed:

* Soldering (both through-hole and surface-mount components)
* Basic understanding of PCB design and electronics
* Familiarity with microcontrollers

### Tools & Materials:[​](#tools--materials "Direct link to Tools & Materials:")
### Tools & Materials:

* Soldering iron and solder
* Fine-tip tweezers
* Enclosure (3D printed)

***

## Important Notes[​](#important-notes "Direct link to Important Notes")
## Important Notes

* **Safety First:** Always follow safety precautions when working with electronics and soldering equipment.
* **Custom PCB for Developer Kit 2:** Due to its reliance on a custom PCB, Developer Kit 2 cannot be built without specialized manufacturing.
Loading