Skip to content

docs: Add "Contributing to docs" - #10594

Merged
zspriggs merged 3 commits into
RaspberryPiFoundation:mainfrom
zspriggs:contributing-docs
Oct 19, 2026
Merged

zspriggs merged 3 commits into
RaspberryPiFoundation:mainfrom
zspriggs:contributing-docs

Conversation

@zspriggs

Copy link
Copy Markdown
Contributor

The basics

The details

Resolves

Fixes #10541
Fixes #10169

Proposed Changes

  • Contributes the contribute to docs doc :)
  • Added a docs/ folder to the "Contribute" section of the guides, included the codelab guide.

I spent some time debating whether this should live inside the "Core" folder of the contributing or not. The plugins docs live in the "Core" category, so by that logic maybe docs should as well, since it's all in the same repo. However, much of the information in the "Core" category of the contributing docs regards setup and testing processes that don't apply to docs (but do apply to plugins). So I added docs as its own standalone section, but happy to move it into "Core" if that makes more sense.

Reason for Changes

Most of the contributing docs are written assuming that a contributor is making code changes rather than docs only changes. However, many of our good first issues (and issues in general) are docs issues, so it makes sense to have a dedicated page outlining how to contribute to docs.

There's also a lot of small details about contributing to docs that previously you had to essentially learn by doing. Although much of what is in this document (adding redirects, new files to sidebars.js, refreshing reference docs) will likely only be done by Blockly team members, it's still useful to document even if just for current/future team members.

Test Coverage

n/a

Documentation

Additional Information

@zspriggs
zspriggs requested a review from a team as a code owner October 19, 2026 19:28
@zspriggs
zspriggs requested a review from lizschwab October 19, 2026 19:28
@github-actions github-actions Bot added the PR: docs Adds or updates documentation label Oct 19, 2026
@zspriggs zspriggs changed the title docs: Add "Contributing to docs" docs: Add "Contributing to docs" Oct 19, 2026
@github-actions github-actions Bot added PR: docs Adds or updates documentation and removed PR: docs Adds or updates documentation labels Oct 19, 2026
@zspriggs
zspriggs merged commit a7ad2c6 into RaspberryPiFoundation:main Oct 19, 2026
12 of 13 checks passed
@zspriggs
zspriggs deleted the contributing-docs branch October 30, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: docs Adds or updates documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add "contributing to docs" guide Information on running docs locally should be more visible

2 participants