Repository navigation
docs: Add "Contributing to docs" - #10594
Merged
Merged
Conversation
lizschwab
approved these changes
Oct 19, 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 #10541
Fixes #10169
Proposed Changes
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