Skip to content

Migrate blockDocs to VisualCircuit-resources and update links - #495

Open
Sarvesh-Mishra1981 wants to merge 3 commits into
JdeRobot:masterfrom
Sarvesh-Mishra1981:feature/migrate-blocks-to-marketplace
Open

Migrate blockDocs to VisualCircuit-resources and update links#495
Sarvesh-Mishra1981 wants to merge 3 commits into
JdeRobot:masterfrom
Sarvesh-Mishra1981:feature/migrate-blocks-to-marketplace

Conversation

@Sarvesh-Mishra1981

Copy link
Copy Markdown
Collaborator

Context

With the introduction of the new decentralized Marketplace, all custom blocks and their metadata are now hosted in the external VisualCircuit-resources repository.

To make the documentation process fully automated, we are moving the static blockDocs out of the main VisualCircuit repository and into the resources repository. This allows a new GitHub Actions workflow in VC-resources to automatically detect and add newly merged Custom Blocks to Blocks.html, removing the need to manually update the core VisualCircuit repository whenever a new community block is added.

What Changed

Removed Local Documentation

  • Removed the docs/blockDocs/ directory and its static HTML files from the main repository.
  • Documentation for Custom Blocks will now be maintained and generated through the VisualCircuit-resources repository.

Updated Documentation Link

  • Updated the Docs button in the top menu (frontend/src/components/menu/index.tsx).
  • The button now redirects users to the new GitHub Pages URL where the Custom Block documentation is hosted.

Why This Change?

This keeps the core VisualCircuit repository cleaner and makes the documentation workflow easier to maintain. New community blocks can now be documented automatically as they are merged, without requiring additional manual changes to the main codebase.

@Sarvesh-Mishra1981

Copy link
Copy Markdown
Collaborator Author

@toshan-luktuke @BkPankaj Have a look on this

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.

1 participant