Skip to content

docs: starter-repo follow-ups are done - #8

Merged
brendonthiede merged 1 commit into
mainfrom
docs-starter-followups
Sep 18, 2026
Merged

brendonthiede merged 1 commit into
mainfrom
docs-starter-followups

Conversation

@brendonthiede

@brendonthiede brendonthiede commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

CLAUDE.md still listed two starter-repo changes as "required, not yet done". Both are already in ../pybricks-spike-prime-starter (main). I checked them before changing the docs; this PR is docs only.

  • check_project.py accepts the bundle-hint preamble (_strip_bundle_hints). It passes on a menu_config.py written by this repo's own generateMenuConfig(), including a whole-program slot and an enabled: False slot. It still reports a PROBLEM for a non-import inside the if _BUNDLE_HINTS: block, and for any stray top-level statement.
  • The committed menu_config.py carries the hint block. ModuleFinder over the starter's main.py now reaches mission_01_go_out_and_turn and mission_02_come_back_home; CLAUDE.md recorded that it used to find neither. Over a generated config it also reaches math_demo and mission_template.

The "Starter-repo follow-ups" section becomes a short "Starter-repo compatibility" record, with a reminder to re-run the starter's checker if the generator's output shape changes again.

The production prerequisite paragraph is updated too. robot_setup_template.py is now authored and committed in the starter (ad88b2c). What remains is per-team: each fork needs its own robot_setup.py, made from the template in the editor. The starter deliberately has none, and check_project.py reports that as INFO.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated project guidance to reflect completed starter compatibility work.
    • Documented support for the bundle-hint preamble and required mission imports.
    • Added verification details and clarified the remaining setup step: creating and committing the required robot setup file from the provided template.

check_project.py already accepts the bundle-hint block (verified against
a generateMenuConfig() file, and it still rejects stray code), and the
starter's committed menu_config.py carries the hints, so ModuleFinder
now reaches both sample missions. robot_setup_template.py exists now;
what remains is each team's own robot_setup.py.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Lansing-Tech-Studio/pybricks-git-extension/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: d7334bbb-60fd-470d-ad05-581b97443582

📥 Commits

Reviewing files that changed from the base of the PR and between d43d96a and 4e56be6.

📒 Files selected for processing (1)
  • CLAUDE.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

CLAUDE.md now documents completed starter-repo compatibility support and the remaining requirement for each team fork to create and commit robot_setup.py.

Changes

Starter-repo compatibility documentation

Layer / File(s) Summary
Compatibility documentation
CLAUDE.md
The documentation now states that check_project.py accepts the bundle-hint preamble and that menu_config.py includes mission imports. It records verification details and the remaining requirement to create and commit robot_setup.py from the template.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 4e56b

This documentation update records verified compatibility behavior and the remaining setup prerequisite without changing runtime code.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies a documentation change that records completed starter-repository follow-ups. It accurately summarizes the main purpose of the pull request.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Docs Track Contracts ✅ Passed The review-scoped diff changes only CLAUDE.md. It does not change src/background.js, src/inject.js, any chrome.storage.local access under src/, or manifest.json content-script order. The d…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@brendonthiede
brendonthiede merged commit 0506cbb into main Sep 18, 2026
2 checks passed
@brendonthiede
brendonthiede deleted the docs-starter-followups branch September 18, 2026 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant