Skip to content

docs: refactor getting-started codelab to be based on sample app#10074

Merged
zspriggs merged 12 commits into
RaspberryPiFoundation:mainfrom
zspriggs:getting-started-remake
Jul 8, 2026
Merged

docs: refactor getting-started codelab to be based on sample app#10074
zspriggs merged 12 commits into
RaspberryPiFoundation:mainfrom
zspriggs:getting-started-remake

Conversation

@zspriggs

Copy link
Copy Markdown
Contributor

The basics

The details

Proposed Changes

  • Refactors the getting-started codelab to be based on the existing sample app rather than the custom music-maker app.
  • The content has remained the same where possible, with slightly more elaboration throughout on what the copy & paste code is actually doing.
  • The codelab goes over largely the same topics, but focuses more on important Blockly concepts than configuring a specific page.
  • Adds the sample app README to the getting started docs, so that the existence of the sample app is more visible and the overview can be referenced from the codelabs.

@zspriggs zspriggs requested a review from a team as a code owner June 26, 2026 16:48
@zspriggs zspriggs requested a review from mikeharv June 26, 2026 16:48
@gonfunko

Copy link
Copy Markdown
Contributor

This also fixes RaspberryPiFoundation/blockly-samples#1752

@maribethb maribethb 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.

Sorry it's a lot of comments but overall the structure is great and I've mostly suggested some wording changes or minor reorganization!

Comment thread packages/docs/docs/codelabs/getting-started/complete-code/src/blocks/text.js Outdated
Comment thread packages/docs/docs/codelabs/getting-started/create-a-blockly-workspace.mdx Outdated
Comment thread packages/docs/docs/codelabs/getting-started/create-a-blockly-workspace.mdx Outdated
Comment thread packages/docs/docs/codelabs/getting-started/create-a-custom-block.mdx Outdated
Comment thread packages/docs/docs/codelabs/getting-started/run-generated-code.mdx Outdated
Comment thread packages/docs/docs/codelabs/getting-started/run-generated-code.mdx
Comment thread packages/docs/docs/codelabs/getting-started/save-load-workspace.mdx Outdated
Comment thread .gitignore Outdated
@zspriggs zspriggs requested a review from maribethb July 7, 2026 14:13
Comment thread packages/docs/docs/codelabs/getting-started/complete-code/src/blocks/text.js Outdated
import * as Blockly from 'blockly/core';
```

This codelab will go over generators in the [generate JavaScript code](/codelabs/getting-started/generate-javascript-code) step, but for now just note that generators will need to be imported separately, like so:

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.

It might be easier to just say "We'll learn how to import generators in step ##" and leave the actual import statement for then.

But I'm also not sure if they know what a generator is at this point, so maybe best to leave it off entirely?

Comment thread packages/docs/docs/codelabs/getting-started/create-base-app.mdx Outdated
@zspriggs zspriggs merged commit f34f8b9 into RaspberryPiFoundation:main Jul 8, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants