Repository navigation
docs: add codelab style rules to the codelab guide - #10622
Merged
zspriggs merged 1 commit intoOct 26, 2026
Merged
Conversation
Fixes RaspberryPiFoundation#10550. - Add writing style rules for instructions, "we", "you", and function names. - Recommend basing new codelabs on the sample app. - Fix two broken GitHub links and a typo. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
github-actions
Bot
added
PR: docs
1 of 3 tasks
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 #10550
Proposed Changes
Updates the Write a codelab guide with the style rules applied to the codelabs in #10575, #10609, #10615, #10618, and #10621, as requested in #10550:
functionNamerather thanfunctionName(), with parameters only when relevantnpx @blockly/create-package app), with links to the sample app overview and the getting started codelab. The outline's setup step now says "Create the sample app" instead of "Download the repository code".Also fixes a few small issues found along the way:
static/images/codelabslinks pointed totree/main/docs/..., which no longer exists. They now point totree/main/packages/docs/....Reason for Changes
Writing the rules down gives new codelab authors and reviewers a shared standard, so the style stays consistent after this cleanup.
Test Coverage
Ran
eslinton the changed.mdxfile with no errors, and checked that the new link targets exist. Text-only change, so no new tests.Documentation
This PR is a documentation change.
Additional Information
This is the last item in #10550. If #10621 is still open when this one is ready, it may be worth merging that one first, since merging this PR will close the issue.
🤖 Generated with Claude Code