Skip to content

docs: style updates to css and custom-generator codelabs - #10621

Open
ritfiz wants to merge 1 commit into
RaspberryPiFoundation:mainfrom
ritfiz:docs/codelab-style-css-generator
Open

ritfiz wants to merge 1 commit into
RaspberryPiFoundation:mainfrom
ritfiz:docs/codelab-style-css-generator

Conversation

@ritfiz

@ritfiz ritfiz commented Oct 24, 2026

Copy link
Copy Markdown
Contributor

The basics

The details

Resolves

Towards #10550

Proposed Changes

Updates the wording in the Use CSS in Blockly and Build a Custom Generator codelabs to match the style used in #10575, #10609, #10615, and #10618:

  • Instructions are written in the imperative, without "we", "let's", or "you need to" (for example, "Use statementToCode to get the code..." rather than "We'll use statementToCode to get the code...").
  • Explanations that referred to "we" or "our" are reworded neutrally (for example, "The next section changes that" rather than "We will change that soon").
  • "You" is kept for observations and stage-setting sentences at the start of a step.

Neither codelab referred to functions with trailing parentheses in its prose, so there are no functionName() changes.

Also fixes a few small issues found along the way:

  • The "generators directory" link in the custom generator summary pointed to tree/main/generators, which no longer exists. It now points to tree/main/packages/blockly/generators.
  • "the counts with block" is now "the count with block" in the CSS tour, matching the rest of the page.
  • "colours from themes codelab" is now "colours from the themes codelab".
  • "here is block generator" is now "here is the block generator", and "all of of the blocks" is now "all of the blocks".

Code samples and code comments are unchanged.

Reason for Changes

Consistent, imperative instructions make the codelabs easier to follow, especially for developers who read English as a second language.

Test Coverage

Ran eslint on the changed .mdx files with no errors, and checked that the new link target exists. Text-only changes, so no new tests.

Documentation

This PR is a documentation change.

Additional Information

This covers the last two codelabs in #10550. The codelab guide update is in a separate PR.

🤖 Generated with Claude Code

Part of RaspberryPiFoundation#10550.

- Word instructions in the imperative, without "we", "let's", or
  "you need to".
- Fix a broken generators directory link and three small typos.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ritfiz
ritfiz requested a review from a team as a code owner October 24, 2026 08:51
@ritfiz
ritfiz requested a review from lizschwab October 24, 2026 08:51
@github-actions github-actions Bot added the PR: docs Adds or updates documentation label Oct 24, 2026

This branch has not been deployed

No deployments
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.

2 participants