Repository navigation
Improve style consistency of codelabs #10550
Description
Location
No response
Type
- Text
- Image or Gif
- Other
Suggested content
As an extension of #10482, we should improve the style consistency of codelabs across the board.
- Instructions should be written in the imperative for all codelabs (Change custom renderer/generator codelabs to using imperative tone #10482)
- Remove use of "we" unless referring to the Blockly team (i.e. "We recommend you do X" is acceptable, but not "Now we'll do the next step")
- Refer to functions as just
functionNamerather thanfunctionName().functionName(param1, param2)is acceptable if the parameters are relevant to the passage. The codelabs are split between using the parentheses and not using them, but the guides predominantly do not use parentheses, so we should stick with that as the status quo. - Update the codelab guide with these style instructions, and mention that we prefer new codelabs to be based on the sample app
Additional context
No response
Activity
zspriggs commentedon Oct 13, 2026
This should be split into multiple PRs since it is a lot of (small) changes. If you'd like to work on this, feel free to pick 1 or 2 codelabs and submit a PR that fixes just those codelabs.
ritfiz commentedon Oct 22, 2026
Hi, looks like there are total of 9 codelabs
Can I please pick up
custom-toolboxandvalidation-and-warnings?zspriggs commentedon Oct 22, 2026
@ritfiz Yes, thanks for working on this!
ritfiz commentedon Oct 22, 2026
@zspriggs I have opened a PR (#10609) for the same and updated my comment above with the PR link for future reference. If all goes well, and this one gets approved, I will open PRs for the rest of the codelabs. Thanks !
docs: style updates to theme-extension-identifier and context-menu-op…
ritfiz commentedon Oct 23, 2026
@zspriggs - The second last bunch of this series is ready for review, PTAL and TIA - #10618
docs: style updates to custom-mutator and custom-renderer codelabs (#…
ritfiz commentedon Oct 24, 2026
For the last set of changes, I have two PRs
docs: style updates to css and custom-generator codelabs (#10621)
docs: add codelab style rules to the codelab guide (RaspberryPiFounda…