Implement automated Custom Block documentation pipeline - #19
Open
Sarvesh-Mishra1981 wants to merge 13 commits into
Open
Implement automated Custom Block documentation pipeline#19Sarvesh-Mishra1981 wants to merge 13 commits into
Sarvesh-Mishra1981 wants to merge 13 commits into
Conversation
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.
Context
With the new decentralized Custom Block Marketplace, the static block documentation has been moved to this resources repository. This PR automates the documentation process so that whenever a new community block is approved and merged, its documentation is updated automatically without any manual work from maintainers.
What Changed
The
blockDocs/folder has been moved here and theREADME.mdhas been updated with a simple guide for contributors to create, export, and submit custom blocks. A newupdate_docs.pyscript uses the block's JSON file to automatically generate and update its documentation inBlocks.html, including inputs, outputs, parameters, and the existing View Source section.The process is also integrated into the existing GitHub Actions workflow. After changes are pushed to
main, the workflow updates the registry, generates the documentation, and commits both changes automatically.Impact
This makes the documentation process fully automated and keeps the marketplace documentation in sync with the available community blocks. Maintainers only need to review and merge the block files, the rest is handled by the workflow.