Cleaning up documentation#3679
Merged
Merged
Conversation
Added a new section for Direct Flow notifications and improved the Proactive Flow section by consolidating the flowchart for clarity. This update aims to enhance the understanding of notification processes for developers.
Updated the documentation for Omi DevKit 1, DevKit 2, Omi Consumer, and omiGlass to improve clarity and structure. Added detailed overviews, specifications, and setup instructions for each device. Enhanced sections on firmware updates and related documentation, ensuring a more comprehensive resource for users and developers. This update aims to streamline the onboarding process and provide clearer guidance for building and using Omi hardware.
…ancements Revised the Backend Deep Dive documentation to reflect updates in API endpoints, specifically changing the WebSocket connection to `/v4/listen`. Enhanced the data storage section by detailing the roles of Google Cloud Storage and Redis in managing audio files and metadata. Clarified the integration of multiple Speech-to-Text services and improved the explanation of real-time transcription processes. This update aims to provide a more accurate and comprehensive resource for developers working with the Omi backend.
Revamped the assembly instructions and buying guide for the Omi device to improve clarity and usability. The assembly guide now features a structured step-by-step format with visual aids, tips, and warnings to assist users in building the device. The buying guide has been expanded to include detailed parts lists, vendor options, and important notes on component availability. This update aims to streamline the onboarding process for users and provide comprehensive resources for building and purchasing Omi devices.
…amples Revamped the Chat Tools documentation to improve clarity and usability for developers. Introduced structured sections with visual aids, including card groups and steps, to better illustrate the functionality and implementation of chat tools in Omi apps. Enhanced descriptions and examples for tool definitions, endpoint requirements, and best practices, aiming to provide a more intuitive resource for developers integrating custom chat tools.
Revised the Data Import APIs documentation to enhance clarity and usability for developers. Updated the title and description to better reflect the functionality of the APIs. Introduced structured sections with card groups for capabilities, detailed API endpoints, and improved error handling information. This update aims to provide a more intuitive resource for developers integrating data import functionalities within the Omi ecosystem.
Corrected the URL in the Buying Guide documentation to point to the accurate GitHub repository for downloading STL files for the Omi device. This change ensures users have direct access to the correct resources for 3D printing components.
Revised the assembly documentation to replace the "Troubleshooting" card with a "Get Support" card, directing users to community help and support options. Removed the "3D Printing Guide" card from the Buying Guide for a more streamlined resource. Enhanced the Developer API documentation by adding sections for various APIs, including Integration Import APIs and Webhook Triggers, to provide clearer guidance for developers. This update aims to improve user experience and accessibility of support resources.
Revised the href for the "Integration Actions" card in the developer apps introduction to point to the correct "Integrations" page. Removed the "3D Printing Guide" card from both the Getting Started and Flash Device documentation to streamline content and improve user navigation. This update aims to enhance clarity and accessibility of resources for users.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request provides a significant and much-needed cleanup of the documentation. The extensive refactoring of numerous .mdx files using components like <CardGroup>, <Steps>, and <AccordionGroup> has greatly improved the structure, readability, and user experience of the documentation. The updates also correct several broken links and align the content with recent backend changes. Overall, this is an excellent contribution. I have found one point of contradiction in the omiGlass hardware documentation that should be addressed to prevent confusion for users building the device.
Comment on lines
+199
to
+202
| | Task | Status | | ||
| |------|--------| | ||
| | Redesign legs/sides for bigger heads | ⬜ Open | | ||
| | Add switch to design | ✅ Complete | |
Contributor
There was a problem hiding this comment.
There appears to be a contradiction in the documentation regarding the hardware switch. This table indicates that adding a switch to the design is complete. However, a note on line 72 states, 'The current design does not include a switch.' Please clarify which statement is correct and update the documentation to ensure builders are not confused.
Glucksberg
pushed a commit
to Glucksberg/omi-local
that referenced
this pull request
Apr 28, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.