Skip to content

docs: comprehensive README with full props, examples, keyboard shortcuts and troubleshooting#883

Open
tungpham-dev wants to merge 1 commit into
tscircuit:mainfrom
tungpham-dev:improve-readme
Open

docs: comprehensive README with full props, examples, keyboard shortcuts and troubleshooting#883
tungpham-dev wants to merge 1 commit into
tscircuit:mainfrom
tungpham-dev:improve-readme

Conversation

@tungpham-dev
Copy link
Copy Markdown

The existing README for pcb-viewer was minimal and lacked the information
developers need to get started quickly. This PR replaces it with a
comprehensive guide covering:

  • Quick start examples for both tscircuit JSX and raw Circuit JSON input
  • Full props reference table for the PCBViewer component
  • Four practical usage examples (single component, full board, read-only, error handling)
  • Keyboard shortcuts reference
  • Styling guidance
  • Troubleshooting section for the most common issues
  • Related packages table linking to the broader tscircuit ecosystem

This should significantly reduce friction for new users discovering
pcb-viewer for the first time.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 24, 2026

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

Project Deployment Actions Updated (UTC)
pcb-viewer Ready Ready Preview, Comment May 24, 2026 11:48am

Request Review

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