Skip to content

docs: add documentation for <opamp /> element with properties and usage examples#646

Merged
rushabhcodes merged 1 commit into
tscircuit:mainfrom
rushabhcodes:docs/add-opamp-element-docs
May 22, 2026
Merged

docs: add documentation for <opamp /> element with properties and usage examples#646
rushabhcodes merged 1 commit into
tscircuit:mainfrom
rushabhcodes:docs/add-opamp-element-docs

Conversation

@rushabhcodes
Copy link
Copy Markdown
Contributor

This pull request adds comprehensive documentation for the <opamp /> element used in analog circuit design. The new documentation covers an overview, usage example, configurable properties, and pin aliases, making it easier for users to understand and implement operational amplifiers in their projects.

New documentation for <opamp />:

  • Introduced a dedicated documentation page opamp.mdx describing the <opamp /> element, including its purpose, standard connections, and when to use <chip /> instead.
  • Added a usage example with a schematic preview, demonstrating how to instantiate and connect an op-amp in a board definition.
  • Documented the configurable properties (connections, footprint, and symbolName) with descriptions and examples.
  • Listed all pin aliases and explained their mapping, clarifying how to refer to each standard op-amp pin.

Copilot AI review requested due to automatic review settings May 22, 2026 01:24
@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 22, 2026 2:09am

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new built-in element documentation page for <opamp />, intended to help users model and wire up operational amplifiers using standard pin aliases and a schematic-focused example.

Changes:

  • Introduces docs/elements/opamp.mdx with an overview and a CircuitPreview usage example.
  • Documents <opamp /> properties (connections, footprint, symbolName) in a quick-reference table.
  • Lists pin aliases intended to map common op-amp pin roles (inputs, output, supplies).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/elements/opamp.mdx
Comment on lines +28 to +29
<net name="VCC" isPowerNet />
<net name="VEE" isGroundNet />
Comment thread docs/elements/opamp.mdx
Comment on lines +60 to +66
An op-amp has the following pins and aliases:

- `pin1`/`non_inverting_input` - The non-inverting input
- `pin2`/`inverting_input` - The inverting input
- `pin3` or `pin4`/`output` - The output pin
- `pin4` or `pin5`/`positive_supply`/`vcc`/`vdd` - The positive supply pin
- `pin5` or `pin3`/`negative_supply`/`vee`/`vss`/`gnd` - The negative supply pin
@rushabhcodes rushabhcodes force-pushed the docs/add-opamp-element-docs branch from f31d16f to 986cf51 Compare May 22, 2026 02:08
@rushabhcodes rushabhcodes merged commit 14f1d0b into tscircuit:main May 22, 2026
5 checks passed
@rushabhcodes rushabhcodes deleted the docs/add-opamp-element-docs branch May 22, 2026 02:10
@tscircuitbot
Copy link
Copy Markdown


Thank you for your contribution! 🎉

PR Rating:
Impact: Tiny

Track your contributions and see the leaderboard at: tscircuit Contribution Tracker


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.

4 participants