Skip to content

Conversation

@rushabhcodes
Copy link
Contributor

This pull request updates the documentation for the cadmodel element to clarify and expand on how to reposition 3D models, especially with the new zOffsetFromSurface property. It also adds a detailed properties table for easier reference.

Enhancements to documentation for model positioning:

  • Added zOffsetFromSurface as an option for repositioning models, alongside positionOffset and rotationOffset, in the introductory section.
  • Introduced a new section explaining how to use zOffsetFromSurface to control the vertical distance of the model from the PCB surface, including an example usage.

Documentation improvements:

  • Added a comprehensive properties table listing all supported attributes for the cadmodel element, including types and descriptions for modelUrl, stepUrl, positionOffset, rotationOffset, zOffsetFromSurface, size, and modelUnitToMmScale.

Copilot AI review requested due to automatic review settings December 14, 2025 10:01
@vercel
Copy link

vercel bot commented Dec 14, 2025

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

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Dec 14, 2025 10:15am

Copy link
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

This pull request enhances the documentation for the cadmodel element by adding comprehensive information about the zOffsetFromSurface property and introducing a new properties reference table. The documentation now provides users with a clearer understanding of how to position 3D models vertically relative to the PCB surface, along with a centralized reference for all available properties.

Key changes:

  • Added zOffsetFromSurface as a positioning option alongside existing positionOffset and rotationOffset properties
  • Introduced a new dedicated section with example code demonstrating the use of zOffsetFromSurface
  • Added a comprehensive properties reference table listing all supported attributes with their types and descriptions

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

@rushabhcodes rushabhcodes merged commit c0269cf into tscircuit:main Dec 14, 2025
5 checks passed
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.

2 participants