Skip to content

docs: add TI parts engine platform config guide#697

Open
techmannih wants to merge 4 commits into
mainfrom
docs/ti-parts-engine-platform-config
Open

docs: add TI parts engine platform config guide#697
techmannih wants to merge 4 commits into
mainfrom
docs/ti-parts-engine-platform-config

Conversation

@techmannih
Copy link
Copy Markdown
Member

Summary

  • add a new guide for using @tscircuit/ti-parts-engine through custom platform configuration
  • clarify that tscircuit.config.json is for serializable JSON settings, not function-valued platform config
  • expand the platform configuration docs with vendor integration guidance and link to the new TI guide

Why

These changes make it clearer how to wire TI-backed part lookup and ti: footprint support into local tooling without implying that this behavior is built into @tscircuit/eval or should live inside tscircuit.config.json.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 1, 2026 6:34pm

Request Review

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d57115df0a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/guides/running-tscircuit/using-ti-parts-engine.mdx Outdated
Comment on lines +92 to +102
## External Vendor Integrations

You can provide them through a custom platform configuration instead.

For a concrete example, see
[Using ti-parts-engine](./using-ti-parts-engine). That guide shows:

- how to provide a custom TI-backed `partsEngine`
- how to enable explicit `footprint="ti:..."` strings when needed
- how to keep partner-token usage in local tooling instead of browser clients

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I’m not sure we should call out TI specifically in the general platform configuration guide

Copy link
Copy Markdown
Contributor

@seveibar seveibar left a comment

Choose a reason for hiding this comment

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

does this work?

do we support tscircuit.config.ts?

Do not create a ti specific guide, the task was to create a "Using Custom Parts Engines" guide with ti as an example

You have no included the installation step!!!

CC @imrishabh18

@seveibar
Copy link
Copy Markdown
Contributor

seveibar commented Jun 1, 2026

@techmannih this won't work, why are you writing a doc for something you haven't tested! Please get it working in a tsci dev project!!!

@seveibar
Copy link
Copy Markdown
Contributor

seveibar commented Jun 1, 2026

your general steps, other than the installation which is totally incorrect because the package isn't published on npm, are generally correct

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