Skip to content

Document user-facing tscircuit tools#558

Open
DrOetker747 wants to merge 11 commits into
tscircuit:mainfrom
DrOetker747:main
Open

Document user-facing tscircuit tools#558
DrOetker747 wants to merge 11 commits into
tscircuit:mainfrom
DrOetker747:main

Conversation

@DrOetker747
Copy link
Copy Markdown

@DrOetker747 DrOetker747 commented May 10, 2026

/claim #60
/claim #61
/claim #67
/claim #50
/claim #51
/claim #65
/claim #64

Adds a workflow-oriented overview of the user-facing tscircuit tools, covering the online editor, CLI, embeddable viewers, routing/layout tools, part/footprint utilities, converters, and core libraries.

Also expands the contributor repository map, adds focused tutorials for LED-letter layouts and MicroMod M.2 connector usage, fixes the docs edit links, updates the Try Online navbar target, and centers the docs content column.

Verification:

  • npm exec --yes prettier -- --check docs/contributing/user-facing-tools.md docs/contributing/overview-of-projects.md
  • npm exec --yes prettier -- --check docs/contributing/contributor-repository-map.md docs/tutorials/draw-any-letter-with-leds.mdx docusaurus.config.ts docs/tutorials/using-sparkfun-micromod-m2-connectors.mdx docs/elements/connector.mdx src/theme/DocItem/Layout/styles.module.css
  • npx tscircuit docs/tutorials/draw-any-letter-with-leds.mdx snippet compile reached circuit generation; preview PCB tab still reports component-specific rendering errors, noted transparently in PR comments
  • MDX compile check passed for the MicroMod connector tutorial and connector docs
  • git diff --check

Transparency: authored and verified with AI assistance.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 10, 2026 11:23pm

Request Review

@DrOetker747
Copy link
Copy Markdown
Author

/claim #61

This PR now also addresses the archived docs-old bounty for documenting the different tscircuit repositories for contribution:
tscircuit/docs-old#61

I added a contributor-focused repository map that explains which repo owns each part of the ecosystem, what changes belong where, and how contributors should choose the right repository before opening an issue or PR.

Verification before committing locally:

  • npm exec --yes prettier -- --check docs/contributing/contributor-repository-map.md docs/contributing/overview-of-projects.md
  • git diff --check

@DrOetker747
Copy link
Copy Markdown
Author

/claim #67

This PR now also addresses the archived docs-old navbar bounty: tscircuit/docs-old#67

I updated the top navbar link from Use Online on https://tscircuit.com to Try Online on https://tscircuit.com/editor, matching the requested wording and target.

Verification:

  • GitHub web commit content check: docusaurus.config.ts now has to: "https://tscircuit.com/editor" and label: "Try Online"
  • Existing PR checks are re-running on commit bcd2de126772d92c92e2412823f1657dc3badce1

@DrOetker747
Copy link
Copy Markdown
Author

/claim #50

This PR now also addresses the archived docs-old LED letter bounty: tscircuit/docs-old#50

I added docs/tutorials/draw-any-letter-with-leds.mdx, a tutorial with a reusable LedLetter component that:

  • Supports capital A through Z with a hard-coded 5x7 font map
  • Uses the requested usage shape: <LedLetter letter="A" power="net.power" gnd="net.gnd" />
  • Places LEDs from grid math so the PCB letter layout is generated automatically
  • Spreads the schematic positions with math so the parts remain readable
  • Uses 0402/0603 LED and resistor footprint options
  • Adds one current-limiting resistor per LED

Commit: a610063

@DrOetker747
Copy link
Copy Markdown
Author

/claim #51

This PR now also addresses the archived docs-old MicroMod documentation bounty: tscircuit/docs-old#51

I added a new tutorial, docs/tutorials/using-sparkfun-micromod-m2-connectors.mdx, documenting SparkFun MicroMod M.2 connector usage, key pin groups, carrier-board responsibilities, common tscircuit routing patterns, and a review checklist. I also linked it from the <connector /> docs where the standard="m2" hint is documented.

Verification:

  • npm exec --yes prettier -- --check docs/tutorials/using-sparkfun-micromod-m2-connectors.mdx docs/elements/connector.mdx
  • node --input-type=module MDX compile check for the new tutorial and connector docs

Note: full npm run build is blocked locally by an existing webpack ProgressPlugin option validation issue under Node v24 before content compilation; Vercel remains the authoritative build signal for this PR.

@DrOetker747
Copy link
Copy Markdown
Author

/claim #65

This PR now also addresses the archived docs-old bounty for GitHub edit links: tscircuit/docs-old#65

I updated Docusaurus editUrl from the repository browsing route (/tree/main/) to the direct GitHub edit route (/edit/main/), so generated doc edit links open the editor for the corresponding docs file instead of only browsing the file tree.

Verification:

  • node --input-type=module assertion that docusaurus.config.ts contains the /edit/main/ route and no longer contains the old /tree/main/ route
  • git diff --check

@DrOetker747
Copy link
Copy Markdown
Author

/claim #64

Added a targeted docs-layout fix for the centering issue: the desktop doc content column now uses an explicit flexible width with auto margins in the Docusaurus DocItem/Layout CSS module, so the content column stays centered when the table of contents is hidden.

Verification:

  • npm exec --yes prettier -- --check src/theme/DocItem/Layout/styles.module.css
  • git diff --check

@github-actions
Copy link
Copy Markdown

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

@william08190
Copy link
Copy Markdown

Still ready for review. CI, type-check, format-check, and Vercel preview are passing. This PR keeps the grouped docs-old bounty claims active after the automatic stale marker; maintainer edits are enabled if the preferred path is to split or narrow any claim.

@github-actions
Copy link
Copy Markdown

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

@william08190
Copy link
Copy Markdown

Still ready for review after the latest automatic stale marker. The PR remains mergeable, with build, type-check, format-check, and Vercel preview passing. I can split or narrow the grouped docs-old bounty claims if maintainers prefer that path.

@github-actions
Copy link
Copy Markdown

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants