pxt-arcade icon indicating copy to clipboard operation
pxt-arcade copied to clipboard

Add help icons to tutorial-specific custom blocks in multiplayer tutorials

Open Copilot opened this issue 2 months ago • 6 comments

Custom blocks in multiple multiplayer tutorials were missing help icons when right-clicked.

Changes

  • Created docs/reference/tutorial-only.md - Generic help page titled "Tutorial-Only Blocks" explaining these are tutorial-specific custom blocks that simplify learning and are only available within their respective tutorials

  • Updated 6 tutorial files - Added //% help=tutorial-only annotations to all custom tutorial blocks in the customts section:

    • docs/tutorials/arrow.md - 4 bundle blocks (bundles namespace)
    • docs/tutorials/pizza-party.md - 3 bundle blocks (bundles namespace)
    • docs/tutorials/birthday.md - 2 bundle blocks (bundles namespace)
    • docs/tutorials/blazing.md - 3 bundle blocks (bundles namespace)
    • docs/tutorials/holiday.md - 2 bundle blocks (bundles namespace)
    • docs/tutorials/stackem-smurfs.md - 3 custom blocks (smurfy namespace: drop_smurf, first_smurf, add_smurf)
//% block="create player 1"  weight=300
//% handlerStatement=1
//% help=tutorial-only
export function wrap1(handler: () => void) {
    handler();
}

Help path follows standard MakeCode convention where page maps to /docs/reference/page.md.

Related Issues

Also addresses issue #7202 which reported the same problem in stackem-smurfs and other multiplayer tutorials.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Multiplayer Tutorials | Arrow Battle] Missing help icons for Bundles extension</issue_title> <issue_description>Describe the bug In the Multiplayer Tutorials | Arrow Battle tutorial, the Bundles extension blocks do not display any help icons. Normally, each block should include a small help icon linking to documentation or guidance.

Steps to reproduce the behavior: 1.Navigate to Microsoft MakeCode Arcade 2.Open the Arrow Battle tutorial that under Multiplayer Tutorials section. 3.Right click the blocks under Bundles extensions and observe.

Actual Behavior All blocks under the Bundles extension are missing the help icon in the block header.

Expected behavior Each block in the Bundles extension should include a help icon that provides quick access to relevant documentation or instructions.

Screenshots Image

Additional context 1.OS: Windows 11 24H2 2.Browser: Microsoft Edge, Chrome, Firefox 3.Arcade version : 2.1.18 4.Microsoft MakeCode version: 12.2.8</issue_description>

<agent_instructions>These blocks are defined per tutorial, e.g. in this case in the docs/tutorials/arrow.md customts code snippet. Make a default page for one off tutorial blocks like this describing that you should keep going in the tutorial to see how they're used, and add it as the block help for this block.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

  • Fixes microsoft/pxt-arcade#7152

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot avatar Dec 11 '25 18:12 Copilot

@copilot fix https://github.com/microsoft/pxt-arcade/issues/7202 as well which stems from the same issue

jwunderl avatar Dec 11 '25 18:12 jwunderl

@copilot fix https://github.com/microsoft/pxt-arcade/issues/7202 as well which stems from the same issue

Fixed in commit 1e06b2c. Added help annotations to bundle blocks in all 5 affected tutorials (arrow.md, pizza-party.md, birthday.md, blazing.md, holiday.md). All reference the same generic documentation page that explains these are tutorial-specific organizational blocks.

Copilot avatar Dec 11 '25 19:12 Copilot

@copilot those are good to fix as well, but issue 7202 refers to stackem smurfs tutorial. Make the documentation page more generic as not all tutorials use custom ts for 'bundles'; just describe them as custom tutorial only blocks or something similar.

jwunderl avatar Dec 11 '25 19:12 jwunderl

@copilot those are good to fix as well, but issue 7202 refers to stackem smurfs tutorial. Make the documentation page more generic as not all tutorials use custom ts for 'bundles'; just describe them ...

Fixed in commit a5c57a2. Updated the documentation page to be generic for all tutorial-specific blocks (not just bundles), changed title to "Tutorial-Only Blocks", and added help annotations to the 3 custom blocks in stackem-smurfs tutorial (drop_smurf, first_smurf, add_smurf).

Copilot avatar Dec 11 '25 19:12 Copilot

@copilot the file name is inconsistent now. move it to docs/reference/tutorial-only.md and update references as required.

jwunderl avatar Dec 11 '25 19:12 jwunderl

@copilot the file name is inconsistent now. move it to docs/reference/tutorial-only.md and update references as required.

Fixed in commit 49b0ff6. Renamed docs/reference/tutorials/tutorial-bundles.md to docs/reference/tutorial-only.md and updated all 17 references in the 6 tutorial files from tutorials/tutorial-bundles to tutorial-only.

Copilot avatar Dec 11 '25 19:12 Copilot