Skip to content

docs: add user-facing tools overview#711

Open
jddark62 wants to merge 486 commits into
tscircuit:mainfrom
jddark62:docs/user-facing-tools-overview
Open

docs: add user-facing tools overview#711
jddark62 wants to merge 486 commits into
tscircuit:mainfrom
jddark62:docs/user-facing-tools-overview

Conversation

@jddark62

@jddark62 jddark62 commented Jun 5, 2026

Copy link
Copy Markdown

Claims tscircuit/docs-old#60.

/claim #60

Summary

  • Add a dedicated "User-facing tools" section to the existing project overview.
  • Route readers to the online editor, CLI, RunFrame, PCB viewer, 3D viewer, autorouting.com, and Circuit JSON converter docs/repos.
  • Keep the existing repository map intact while making the page more useful for users who need to pick the right tool before contributing.

Verification

  • git diff --check
  • Local Markdown link existence check for relative .md / .mdx links in docs/contributing/overview-of-projects.md
  • ASCII-only check for the changed file
  • Markdown fence balance check

Not run: bunx biome format docs/contributing/overview-of-projects.md because bunx is not installed in this environment.

Notes

The original bounty issue is in the archived tscircuit/docs-old repository, which is read-only and does not allow a fresh /attempt comment. This PR targets the active tscircuit/docs repository, matching the pattern used by other docs-old bounty claims.

seveibar and others added 30 commits October 9, 2025 22:02
…tPreview, support loading static assets from docs (tscircuit#208)

* simplify import example, give example using projectBaseUrl for CircuitPreview

* test static model loading w/ circuit preview from docs static assets dir
* add the doc for the tsconfig path resolutoin

* update the snippet-url

* update the snippet-url

* update

* move to the ts guides

* move to the ts guides
…dd initial part of group layout page (tscircuit#213)

* fix circuit preview mucking

* fix file path
* Add Bullet styled Index page

* Bring back old pagination and also add spacing

* Support nested categories

* Center items in mobile

* Revert padding to center on mobile

* Add description to sub category
…ing before first para. (tscircuit#223)

* Add space above first para

* Add missing or incomplete descriptions

* Fix the Markdown Format while rendering
* doc for tscircuit.config.json

* add support for bash color scheme

* Update docs/guides/tscircuit-essentials/tscircuit-config.mdx

Co-authored-by: Severin Ibarluzea <seveibar@gmail.com>

* add the complete example at the top

---------

Co-authored-by: Severin Ibarluzea <seveibar@gmail.com>
* Trying to fix overview header

* Properly align the header with rest of the body
* Added led color doc

* changed colro order

* changed colro order

* patch
* Document <hole /> with pill shape and rotation

* fix circle hole

* change wording

* Update docs/elements/hole.mdx

Co-authored-by: Rishabh Gupta <38923768+imrishabh18@users.noreply.github.com>

* Update docs/elements/hole.mdx

Co-authored-by: Rishabh Gupta <38923768+imrishabh18@users.noreply.github.com>

* use browser3d false

---------

Co-authored-by: Rishabh Gupta <38923768+imrishabh18@users.noreply.github.com>
* docs: explain obstructsWithinBounds for chip

* docs: tweak obstructsWithinBounds preview
thisisharsh7 and others added 20 commits May 12, 2026 21:51
Added information about the internal available area for lab boards.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…scircuit#702)

* Add documentation for cornerRadius property in silkscreen rectangles

* remove exapmle
@vercel

vercel Bot commented Jun 5, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 5, 2026 5:33pm

Request Review

@github-actions

github-actions Bot commented Jun 8, 2026

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.