Automate Syncing Docs to SDK README.md#2128
Closed
SaikiranSurapalli17 wants to merge 5 commits intoBasedHardware:mainfrom
Closed
Automate Syncing Docs to SDK README.md#2128SaikiranSurapalli17 wants to merge 5 commits intoBasedHardware:mainfrom
SaikiranSurapalli17 wants to merge 5 commits intoBasedHardware:mainfrom
Conversation
Collaborator
|
@logicforge17, 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 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
3 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.
This PR introduces a GitHub Action to automate syncing
.mdxdocumentation back intoREADME.mdfiles in the SDK directories.Runs when
.mdxfiles indocs/docs/are updated.Reads the corresponding
.mdxfile, removes metadata (title,description), writes the processed content into the mappedREADME.md, and appends a notice:"This file is auto-generated from docs. Do not edit manually."
A predefined dictionary in the GitHub Action determines which
.mdxfiles map to whichREADME.mdfiles.Fixes #2112
/claim #2112