docs(skills): point sdk-install guides at per-language install pages - #358
Conversation
The sdk-install-<language> skills sent agents to the generic https://www.braintrust.dev/docs/instrument/trace-llm-calls page as the source of truth for instrumentation. Point each guide at its own https://www.braintrust.dev/docs/sdks/<language>/install-and-instrument page instead, so the agent lands on docs for the language it is actually installing. Java and C# previously referenced no docs page at all, leaving their hardcoded instrumentation snippets with no freshness check. Add the same source-of-truth line to both. Mirrors braintrustdata/braintrust#20019, which made the same change to the equivalent MCP resources.
|
Latest downloadable build artifacts for this PR commit
Available artifact names
|
The per-language sdk-install guides duplicated install commands, instrumentation snippets, launch-hook wiring, and provider lists that the https://www.braintrust.dev/docs/sdks/<language>/install-and-instrument pages already own. Duplicated content goes stale and competes with the page the agent is told to treat as the source of truth. Cut each guide down to the install docs link plus the SDK repo and package registry, so the agent reads the live docs instead of a local copy that drifts. Reword the two references to a "language-specific resource" now that the resource is just the docs pointer.
Jesse Seldess (jseldess)
changed the title
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 38a508e239
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "Codex (@codex) review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "Codex (@codex) address that feedback".
| # C# SDK Install | ||
|
|
||
| Reference guide for installing the Braintrust C# SDK. | ||
| **Read https://www.braintrust.dev/docs/sdks/csharp/install-and-instrument and follow it.** |
There was a problem hiding this comment.
When bt setup instrument launches a sandboxed or otherwise web-restricted coding agent, this stub leaves it without installation instructions. The setup prefetch only downloads URLs recognized by src/setup/docs.rs::workflow_from_url as /docs/instrument/...; these new /docs/sdks/... pages are excluded, while sdk_install_docs::write_sdk_install_docs merely writes this link into the temporary directory. Thus the CLI can report that the latest docs were fetched successfully and then require a second network access the agent may not have, causing installation to abort or be guessed. Add these language pages to the CLI's prefetch set and point the guides at the downloaded copies.
Useful? React with 👍 / 👎.
2 participants
The sdk-install- skills sent agents to the generic https://www.braintrust.dev/docs/instrument/trace-llm-calls page as the source of truth for instrumentation. Point each guide at its own https://www.braintrust.dev/docs/sdks//install-and-instrument page instead, so the agent lands on docs for the language it is actually installing.
Java and C# previously referenced no docs page at all, leaving their hardcoded instrumentation snippets with no freshness check. Add the same source-of-truth line to both.
These skills are only used by
bt setup instrument, which is deprecated according to our docs, but making these changes just to be safe.