Update README.md - add link to the doc#1971
Merged
Merged
Conversation
Collaborator
|
lgmt @skywinder 🥳 |
Glucksberg
pushed a commit
to Glucksberg/omi-local
that referenced
this pull request
Apr 28, 2026
I will do aggregation to this PR all the minor doc fixes. Feel free to merge it. Added Reference to Documentation: Added a clear reference to the comprehensive Backend Setup documentation at the beginning Added an "Additional Resources" section at the end with links to full documentation Improved Structure and Formatting: Organized the content with clear headings and better formatting Used consistent bullet points and code blocks for better readability Added proper indentation and spacing for easier scanning Added Missing Links: Added direct links to all API key pages (OpenAI, Deepgram, etc.) Added links to installation resources (pip, Firebase, etc.) Added links to specific Google Cloud API pages Enhanced Instructions: Provided platform-specific instructions (Mac, Windows, Nix) Added more detailed explanations for each step Improved troubleshooting information Added Context: Clarified why certain steps are necessary Added explanations for environment variables and configuration
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
2 participants
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.
I will do aggregation to this PR all the minor doc fixes. Feel free to merge it.
Added Reference to Documentation:
Added a clear reference to the comprehensive Backend Setup documentation at the beginning
Added an "Additional Resources" section at the end with links to full documentation
Improved Structure and Formatting:
Organized the content with clear headings and better formatting
Used consistent bullet points and code blocks for better readability
Added proper indentation and spacing for easier scanning
Added Missing Links:
Added direct links to all API key pages (OpenAI, Deepgram, etc.)
Added links to installation resources (pip, Firebase, etc.)
Added links to specific Google Cloud API pages
Enhanced Instructions:
Provided platform-specific instructions (Mac, Windows, Nix)
Added more detailed explanations for each step
Improved troubleshooting information
Added Context:
Clarified why certain steps are necessary
Added explanations for environment variables and configuration