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

[beastoin]

We (OMI) are a small team. That's why we need to reduce the friction of every single task. Docs update is one of these things.

My mate, Nik, looks sad when removing the readme.md content at https://github.com/BasedHardware/omi/tree/main/sdks/react-native to centralize the docs at https://docs.omi.me/docs/developer/sdk/ReactNative (mintlify that reflected at https://github.com/BasedHardware/omi/blob/main/docs/docs/docs/developer/sdk/ReactNative.mdx).

So, I have an idea. Let's sync the docs .mdx file to the README.md backward:

1. Use GitHub Action, trigger on changes at https://github.com/BasedHardware/omi/blob/main/docs/docs/
2. Then, create a .md file and put it back to https://github.com/BasedHardware/omi/tree/main/sdks/react-native/README.md. Of course, we should have a note like: this file is generated by ..., do not edit manually, and remove the meta (title, description).
3. Of course, we will have a map of docs .mdx file -> readme.md file, just put it(the mapping) directly into the GitHub Action's code.

Feel free to tell me what you think.

[beastoin]

/bounty $200

[Myestery]

Hi @beastoin
I'll like to attempt this one.
Should be able to finish it today if I get assigned

[krushnarout]

@beastoin Here's a demo repo where I tested the workflow, and everything is working well. Please check https://github.com/krushnarout/omi-docs-test. Here's the PR #2116

[beastoin]

@krushnarout cool man.

1/ does it work with the image? or the link if the .mdx has them, the related path, you know.

[krushnarout]

1/ does it work with the image? or the link if the .mdx has them, the related path, you know.

@beastoin Yes! It works because the images used in the SDK docs are GitHub user-attachment link example: https://github.com/user-attachments/assets/7e59be15-48dc-4ff1-bcf1-235b8bab3990. I also tested it with a swift.mdx file that contains images. You can check them here https://github.com/krushnarout/omi-docs-test/tree/main/sdks/swift

[beastoin]

1/ try with https://docs.omi.me/docs/assembly/Build_the_device https://github.com/BasedHardware/omi/blob/main/docs/docs/docs/assembly/Build_the_device.mdx

@krushnarout

[krushnarout]

1/ try with https://docs.omi.me/docs/assembly/Build_the_device https://github.com/BasedHardware/omi/blob/main/docs/docs/docs/assembly/Build_the_device.mdx

@beastoin

1/ For local images, I thought we didn’t need to handle them since SDK don’t have any, but here’s how to handle that.

if [[ "$README_FILE" == assembly/* ]]; then
  sed -i 's|](/images/|](../docs/images/|g' temp.md
else
  sed -i 's|](/images/|](../../docs/images/|g' temp.md
fi

Ref: https://github.com/krushnarout/omi-docs-test/blob/9b4295025a58c1b1480c7c7920718982641031e8/.github/workflows/sync_docs.yml#L42C13-L46C18

I've tested it and everything is working fine! Please check: https://github.com/krushnarout/omi-docs-test/blob/main/assembly/README.md

2/ We need to handle this based on the folder structure. Can you specify which folder needs this handling so I can update the PR? Here I've updated my PR #2116