docs: fix broken non-React README example#2004
Merged
seveibar merged 1 commit intotscircuit:mainfrom Mar 5, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
Quick follow-up: this PR is ready for maintainer review/merge on my side. Happy to make any requested changes immediately. |
seveibar
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What I noticed
The non-React usage snippet in the README had a few copy/paste errors (
project.add,LED1,getJson) that can confuse new contributors following the example.What I changed
project.add(board)withcircuit.add(board)L1before wiring the traceLED1->L1in trace connectiongetJson()->getCircuitJson()Why this is worth fixing
This is one of the first snippets people try. Keeping it runnable as-written reduces onboarding friction and avoids avoidable support questions.