Skip to content

docs: style updates to theme-extension-identifier and context-menu-option codelabs - #10615

Merged
zspriggs merged 1 commit into
RaspberryPiFoundation:mainfrom
ritfiz:docs/codelab-style-theme-context-menu
Oct 23, 2026
Merged

zspriggs merged 1 commit into
RaspberryPiFoundation:mainfrom
ritfiz:docs/codelab-style-theme-context-menu

Conversation

@ritfiz

@ritfiz ritfiz commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

The basics

The details

Resolves

Towards #10550

Proposed Changes

Updates the wording in the Customizing Your Themes and Customizing Context Menus codelabs to match the style used in #10575 and #10609:

  • Instructions are written in the imperative, without "we" or "let's" (for example, "For instance, disable helloWorldItem..." rather than "For instance, let's disable helloWorldItem...").
  • "You" is kept for observations and for stage-setting sentences at the start of a step (for example, "In this section you will create a very basic Halloween theme...").
  • Functions are referred to as functionName rather than functionName().

Also fixes a few small issues found along the way:

  • The block styles link label had the period inside the brackets ([documentation.]).
  • The "Precondition: Node type" heading had a stray space (4 . Precondition).
  • "information about menu option" is now "information about menu options".

Code samples and code comments are unchanged, as are the "What you'll learn / build / need" headings.

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. Text-only changes, so no new tests.

Documentation

This PR is a documentation change.

Additional Information

This covers two more codelabs, as suggested in #10550.

🤖 Generated with Claude Code

…tion codelabs

Part of RaspberryPiFoundation#10550.

- Word instructions in the imperative, without "we" or "let's".
- Refer to functions without trailing parentheses.
- Fix a link label, a heading typo, and a grammar typo.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ritfiz
ritfiz requested a review from a team as a code owner October 23, 2026 09:31
@ritfiz
ritfiz requested a review from zspriggs October 23, 2026 09:31
@github-actions github-actions Bot added the PR: docs Adds or updates documentation label Oct 23, 2026
@ritfiz ritfiz mentioned this pull request Oct 23, 2026
1 of 3 tasks

@zspriggs zspriggs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for the contribution!

@zspriggs
zspriggs merged commit b9ca7b1 into RaspberryPiFoundation:main Oct 23, 2026
11 checks passed
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