Skip to content

feat: sync SDK docs to README via GitHub Action#2116

Merged
beastoin merged 2 commits intoBasedHardware:mainfrom
krushnarout:feat-sync-docs
Mar 31, 2025
Merged

feat: sync SDK docs to README via GitHub Action#2116
beastoin merged 2 commits intoBasedHardware:mainfrom
krushnarout:feat-sync-docs

Conversation

@krushnarout
Copy link
Copy Markdown
Member

@krushnarout krushnarout commented Mar 28, 2025

closes #2112
/claim #2112

@beastoin @kodjima33 Here's a demo repo where I tested it, and everything is working well. Please check: https://github.com/krushnarout/omi-docs-test. Let me know your thoughts!

@beastoin beastoin merged commit dcbe2a9 into BasedHardware:main Mar 31, 2025
@beastoin
Copy link
Copy Markdown
Collaborator

lgtm @krushnarout,

please take some rest and waiting for more feedback.

@krushnarout
Copy link
Copy Markdown
Member Author

lgtm @krushnarout,

Thanks!

My mate, Nik, looks sad when removing the readme.md

Hope he’ll be happy now : )

@krushnarout krushnarout deleted the feat-sync-docs branch March 31, 2025 08:36
@beastoin
Copy link
Copy Markdown
Collaborator

Screenshot 2025-03-31 at 18 22 34

could you fix @krushnarout ?

@krushnarout
Copy link
Copy Markdown
Member Author

krushnarout commented Mar 31, 2025

could you fix @krushnarout ?

@beastoin

1/ Running it manually will not work, it only works when you push some new changes or merge a pull request.

2/ I've made a PR #2133 with minor doc fixes—merge it, and the action will work!

beastoin added a commit that referenced this pull request Apr 1, 2025
@beastoin
Copy link
Copy Markdown
Collaborator

beastoin commented Apr 1, 2025

#2133 (comment)

@krushnarout
Copy link
Copy Markdown
Member Author

#2142

Glucksberg pushed a commit to Glucksberg/omi-local that referenced this pull request Apr 28, 2026
closes BasedHardware#2112 
/claim BasedHardware#2112 

@beastoin @kodjima33 Here's a demo repo where I tested it, and
everything is working well. Please check:
https://github.com/krushnarout/omi-docs-test. Let me know your thoughts!
Glucksberg pushed a commit to Glucksberg/omi-local that referenced this pull request Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a .github action to sync the docs backward to the repo's README.md.

2 participants