Skip to content

Commit cee7ecd

Browse files
committed
feat: refine bt setup wizard flow, add recommended test-project picker, and update URL format docs
- resolve a single coding agent for the wizard instead of configuring all detected agents - default instrumentation workflow docs to all workflows - make TUI the default when available - add recommended {whoami}-test project creation to the project picker - make --language conflict with --no-instrument - clarify Braintrust app URL format guidance for generated docs
1 parent 2f4495e commit cee7ecd

File tree

3 files changed

+268
-138
lines changed

3 files changed

+268
-138
lines changed
Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
11
# Braintrust URL Formats
22

3-
## App Links (Current Format)
3+
Use `BRAINTRUST_APP_URL` as the source of truth for app links. It already includes the scheme
4+
and any required base path. On hosted Braintrust, the default is
5+
`https://www.braintrust.dev/app`.
6+
7+
## App Links
48

59
### Experiments
610

7-
`https://BRAINTRUST_APP_URL/{org}/p/{project}/experiments/{experiment_name}?r={root_span_id}&s={span_id}`
11+
`{BRAINTRUST_APP_URL}/{org}/p/{project}/experiments/{experiment_name}?r={root_span_id}&s={span_id}`
812

913
### Datasets
1014

11-
`https://BRAINTRUST_APP_URL/{org}/p/{project}/datasets/{dataset_name}?r={root_span_id}`
15+
`{BRAINTRUST_APP_URL}/{org}/p/{project}/datasets/{dataset_name}?r={root_span_id}`
1216

1317
### Project Logs
1418

15-
`https://BRAINTRUST_APP_URL/{org}/p/{project}/logs?r={root_span_id}&s={span_id}`
19+
`{BRAINTRUST_APP_URL}/{org}/p/{project}/logs?r={root_span_id}&s={span_id}`
1620

1721
## Legacy Object URLs
1822

19-
`https://BRAINTRUST_APP_URL/object?object_type=...&object_id=...&id=...`
23+
`{BRAINTRUST_APP_URL}/object?object_type=...&object_id=...&id=...`
2024

2125
## URL Parameters
2226

23-
| Parameter | Description |
24-
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25-
| r | The root_span_id - identifies a trace |
26-
| s | The span_id - identifies a specific span within the trace |
27-
| id | Legacy parameter for root_span_id in object URLs |
28-
| BRAINTRUST_APP_URL | url where the app is accessible, www.braintrust.dev/app for non self-hosted instances. See the env variable BRAINTRUST_APP_URL (and use www.braintrust.dev/app if it is not set) |
27+
| Parameter | Description |
28+
| --------- | ----------- |
29+
| `r` | Root span ID. Identifies a trace. |
30+
| `s` | Span ID. Identifies a specific span within a trace. |
31+
| `id` | Legacy root span ID parameter in object URLs. |
2932

3033
## Notes
3134

32-
- The `r=` parameter is always the root_span_id
33-
- For logs and experiments, use `s=` to reference a specific span within a trace
35+
- The `r=` parameter is always the `root_span_id`.
36+
- For logs and experiments, use `s=` to reference a specific span within a trace.

0 commit comments

Comments
 (0)