Repository navigation
chore: generate plugins reference docs - #10637
Merged
zspriggs merged 8 commits intoOct 29, 2026
Merged
Conversation
This was referenced Oct 29, 2026
zspriggs
marked this pull request as ready for review
October 29, 2026 15:06
gonfunko
approved these changes
Oct 29, 2026
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
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.
The basics
The details
Resolves
Fixes #10397
Towards #7247
Proposed Changes
Adds plugins to reference docs.
Under the current setup, TypeDoc generates
blockly_api.jsonand commits it during each release, and then the actual.mdreference docs are generated based on the contents ofblockly_api.jsonwhenever docs are deployed.This PR adds another TypeDoc run which generates a
plugins_api.jsonduring the release, and then configures Docusaurus to generate plugins docs based onplugins_api.jsonunder their own "Plugins" folder in the reference sidebar.Reason for Changes
Plugin APIs can/should be documented alongside our regular docs. This also serves to make the plugins more visible and searchable within our docs.
Test Coverage
Tested locally and everything works correctly
Documentation
Added info to
contribute_to_docs.mdxas well asAGENTS.mdand the docs READMEAdditional Information
There's two follow-ups associated with this PR:
index.ts(orindex.js) for each plugin so that TypeDoc can fill in the description columns. This is a simple fix but also a lot for one PR, tracked here: Fix plugin API landing page #10641