chore(ci): sync Mintlify .mdx files to SDK README.md with frontmatter + image path handling#2120
chore(ci): sync Mintlify .mdx files to SDK README.md with frontmatter + image path handling#2120varshith257 wants to merge 10 commits intoBasedHardware:mainfrom
Conversation
…into chore/sync-docs
…automation with images
|
@beastoin @kodjima33 Here's the production ready clean workflow for reverse sync of docs to respective README.md's along with image handling. I am happy to incorporate any suggestions needed. I just used emojis to make the workflow even more interactive(if they aren't needed I will remove them) i have also tested diff docs in temp folder in root and they are syncing nicely |
|
@beastoin Just to update this is first PR submitted resolving image paths too and fulfilling all issue requiremnts. I have observed in other PRs of adding the same logic of this PR to resolve image paths just by renaming them an even the logic is wrong there though. They left exact of this PR var name |
|
@varshith257 Bro, don't say it like that. I added the logic it's just a simple for loop. I'm not dumb enough to not know this. I spent two hours testing it in my demo repo. If you think you're the one who came up with the logic, then why did you use my solution that I spent time fixing from this comment ? Why would I need to copy your logic? I tested it two hours before your pull request. I see you added my solution in this commit fc32b44
|
|
Just check above image. They aren't even similiar. I have followed with your discussions in issue and checked opened PRS, I thought there is room for more improvement and I have clear approach so I have taken step to submit PR. Thanks for providing the test code to check with asssembly docs. As you seen in my commit I have just used for my testing itself and haven't used it for any purposes and I have cleaned it and made it resolve image paths more dynamically without any hardcoded values. I think you have to know that it's not first come first serve basis, the one which is good that wins and reviewers decide them and lock bounty. I am not arguing with your work, just I thought there is room for improvement of current opened PR approaches and submitted this PR 😀 |
|
I said again i am not arguing man, I just left for further reviews for reviewers. It's strange if you see only fancy emojis. Please stop tagging me :) |
Cool, I said because you added my changes image in the comment |
|
man @varshith257, the issue has been done by #2116 , feel free to create new PR to enhance it. appreciate you guys helps ❤️ don't forget to check our > $80K bounties https://omi.me/bounties |



This PR implements a GitHub Action to sync Mintlify .mdx files back to their respective SDK README.md files as described in issue
strips frontmatter cleanly using a production-safe
sedapproachdynamically rewrites image paths based on folder depth and no need of hard coding anymore
auto-injects banner at the top of each README.md as follows
📦 Notes to Reviewers
Fully tested for all SDKs
Handles edge cases like emojis, nested folders and image links and safe for production use
I guess it's ready to close and lock bounty after incorporating any feedback or suggestions from reviewer
Fixes #2112
/claim #2112