Skip to content

chore: generate plugins reference docs - #10637

Merged
zspriggs merged 8 commits into
RaspberryPiFoundation:mainfrom
zspriggs:plugins-api-docs-v3
Oct 29, 2026
Merged

zspriggs merged 8 commits into
RaspberryPiFoundation:mainfrom
zspriggs:plugins-api-docs-v3

Conversation

@zspriggs

@zspriggs zspriggs commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

The basics

The details

Resolves

Fixes #10397
Towards #7247

Proposed Changes

Adds plugins to reference docs.

Under the current setup, TypeDoc generates blockly_api.json and commits it during each release, and then the actual .md reference docs are generated based on the contents of blockly_api.json whenever docs are deployed.

This PR adds another TypeDoc run which generates a plugins_api.json during the release, and then configures Docusaurus to generate plugins docs based on plugins_api.json under 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.mdx as well as AGENTS.md and the docs README

Additional Information

There's two follow-ups associated with this PR:

  • Right now, references to the core Blockly library are stated but not linked to the core API docs. Ideally we'd link back to core Blockly reference docs when applicable, but I determined that was a lot for one PR and a bit outside the scope of this issue. I've filed an issue to track this: Add links from plugins docs to core docs #10640
  • The landing page for the plugins is a bare list of plugins, each with an empty description. I think it's helpful to have an overview page, so I kept it, but plugin descriptions should be added to index.ts (or index.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

@github-actions github-actions Bot added the PR: chore General chores (dependencies, typos, etc) label Oct 27, 2026
@github-actions github-actions Bot added PR: chore General chores (dependencies, typos, etc) and removed PR: chore General chores (dependencies, typos, etc) labels Oct 29, 2026
@zspriggs
zspriggs marked this pull request as ready for review October 29, 2026 15:06
@zspriggs
zspriggs requested a review from a team as a code owner October 29, 2026 15:06
@zspriggs
zspriggs requested a review from gonfunko October 29, 2026 15:06
@zspriggs
zspriggs merged commit f9b3325 into RaspberryPiFoundation:main Oct 29, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: chore General chores (dependencies, typos, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate documentation for plugins

2 participants