Skip to content

Commit 86d2299

Browse files
authored
Merge branch 'main' into fix/4726-self-host-db-init
2 parents 497f747 + b6fafc3 commit 86d2299

893 files changed

Lines changed: 43006 additions & 20987 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.agents/skills/write-pr-description/SKILL.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ Use this shape unless the change is truly trivial:
3939
4040
## Tests / notes
4141
<short bullet list or prose: what you verified, anything reviewers should watch for>
42+
43+
## What to QA
44+
<only for user-visible changes: short steps for the manual tester, see section 7>
4245
```
4346

4447
Adapt the headings if the situation calls for it (e.g. a pure feature PR might use "What this adds" instead of "What was broken"). The order stays the same: the obeservation (symptom or user-visible change first or intent), then the changes, then verification and validation.
@@ -102,7 +105,26 @@ Keep this section short and concrete. Useful contents:
102105
103106
Skip the section entirely if there is nothing real to say. A blank "Tests" heading is worse than no heading.
104107
105-
## 7. Reviewer's first-30-seconds test
108+
## 7. What to QA section
109+
110+
If the change is user-visible and a teammate will test it manually, add a "What to QA" section. Write it for a tester who knows the product and has context: skip the basics, point at the right screens, and state the expected result of every check.
111+
112+
- One line per check: where to go, what to do, what they should see.
113+
- Name the exact pages and flows. "Test the feature" is not a check.
114+
- Include the regression to watch for: the thing this change is most likely to have broken.
115+
- If a check needs setup (a seeded project, an older record, a feature flag), say so in the same line.
116+
- Use simple, clear language. Same prose rules as section 5.
117+
118+
Example:
119+
120+
> ## What to QA
121+
> - Create a new automatic evaluator, name it, save. The table shows your name with a v1 tag, not "default".
122+
> - Edit it and commit a config change. The name stays, the version bumps to v2.
123+
> - Regression: run a new evaluation. The variant chips still say "default", not the app name.
124+
125+
Skip the section when nothing is user-visible (pure refactor, CI, docs). A reviewer-only change needs the Tests section, not this one.
126+
127+
## 8. Reviewer's first-30-seconds test
106128
107129
Before you finalize, read your own draft and ask:
108130
@@ -113,7 +135,7 @@ Before you finalize, read your own draft and ask:
113135
114136
If any answer is no, edit before you push.
115137
116-
## 8. Worked example
138+
## 9. Worked example
117139
118140
A bad first draft:
119141
@@ -147,6 +169,10 @@ After:
147169
## Tests
148170
- Added a unit test in parseToolsFromTrace.test.ts covering both shapes.
149171
- Opened a real OpenInference trace from the staging project and confirmed the tools panel renders.
172+
173+
## What to QA
174+
- Open an OpenInference trace in the playground (the staging project has them). The tools panel lists the tools.
175+
- Regression: open a trace from the OpenAI SDK. The tools panel still renders as before.
150176
```
151177
152178
The second version is cleaner and tells the reviewer everything they need to start reading the diff.

.all-contributorsrc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,52 @@
596596
"platform",
597597
"doc"
598598
]
599+
},
600+
{
601+
"login": "Sanket2329",
602+
"name": "Sanket Shakya",
603+
"avatar_url": "https://avatars.githubusercontent.com/u/196506711?v=4",
604+
"profile": "https://github.com/Sanket2329",
605+
"contributions": [
606+
"code"
607+
]
608+
},
609+
{
610+
"login": "unfitcoder101",
611+
"name": "unfitcoder101",
612+
"avatar_url": "https://avatars.githubusercontent.com/u/175036458?v=4",
613+
"profile": "https://github.com/unfitcoder101",
614+
"contributions": [
615+
"bug"
616+
]
617+
},
618+
{
619+
"login": "Shunmuka",
620+
"name": "Shunmuka Valsa",
621+
"avatar_url": "https://avatars.githubusercontent.com/u/137101604?v=4",
622+
"profile": "https://github.com/Shunmuka",
623+
"contributions": [
624+
"code",
625+
"platform"
626+
]
627+
},
628+
{
629+
"login": "NamHT4Devlop",
630+
"name": "Hồ Trung Nam",
631+
"avatar_url": "https://avatars.githubusercontent.com/u/122743792?v=4",
632+
"profile": "https://github.com/NamHT4Devlop",
633+
"contributions": [
634+
"code"
635+
]
636+
},
637+
{
638+
"login": "Koushik-Salammagari",
639+
"name": "Koushik-Salammagari",
640+
"avatar_url": "https://avatars.githubusercontent.com/u/138836560?v=4",
641+
"profile": "https://github.com/Koushik-Salammagari",
642+
"contributions": [
643+
"bug"
644+
]
599645
}
600646
],
601647
"contributorsPerLine": 7,

.claude/agents/changelog-editor.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,17 @@ You are an expert technical documentation editor specializing in Docusaurus chan
99

1010
## Your Core Responsibilities
1111

12-
1. **Dual Entry Creation**: For every changelog item, you create two coordinated entries:
13-
- A concise summary in `docs/main.mdx`
14-
- A detailed explanation in `docs/block/entries/[version-or-feature].mdx`
15-
- The summary title must link to the detailed entry
12+
1. **Entry Creation**: For every changelog item, you create one entry file in
13+
`docs/blog/entries/[version-or-feature].mdx`. The changelog index page at
14+
`/changelog` is generated automatically from these files (sorted by `date`,
15+
paginated). Each entry holds two texts: a curated short summary wrapped in
16+
`<Summary>...</Summary>`, then a `{/* truncate */}` marker, then the full
17+
write-up. `<Summary>` shows only on the index (as the preview, with a "Read
18+
more" link) and renders nothing on the entry page, so the page shows just
19+
the full write-up. The short summary can differ from the long write-up's
20+
opening; do not just copy its first lines. If the feature has a demo video
21+
or screenshot, put it inside `<Summary>` (so it shows on the index) and
22+
again in the write-up below the marker (so it shows on the entry page).
1623

1724
2. **Version Management**: Before creating any entry, determine the version number. If unclear from context, ask the user: "Which version is this changelog entry for?" Never proceed without a clear version identifier.
1825

@@ -62,8 +69,8 @@ You are an expert technical documentation editor specializing in Docusaurus chan
6269

6370
**Quality Control Checklist (apply to every entry):**
6471
- [ ] Version number present and correct
65-
- [ ] Both short and detailed entries created
66-
- [ ] Short entry links to detailed entry correctly
72+
- [ ] Entry created in `docs/blog/entries/`
73+
- [ ] Curated summary in `<Summary>`, then `{/* truncate */}`, then the full write-up
6774
- [ ] Active voice used where possible
6875
- [ ] No em dashes present
6976
- [ ] Feature documentation linked if applicable
@@ -74,10 +81,9 @@ You are an expert technical documentation editor specializing in Docusaurus chan
7481
## Output Format
7582

7683
When creating or editing changelog entries, provide:
77-
1. The complete markdown for the main.mdx summary entry
78-
2. The complete markdown for the detailed entries/[name].mdx file
79-
3. Confirmation that you've checked for related documentation
80-
4. Build test results
81-
5. Any questions or clarifications needed
84+
1. The complete markdown for the entries/[name].mdx file
85+
2. Confirmation that you've checked for related documentation
86+
3. Build test results
87+
4. Any questions or clarifications needed
8288

8389
Be proactive in identifying unclear requirements and ask specific questions rather than making assumptions. Your goal is to produce changelog entries that are immediately publishable without requiring revision.

.claude/skills/create-changelog-announcement/SKILL.md

Lines changed: 71 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,57 @@ user-invocable: true
88
# Create Changelog Announcement
99

1010
This skill guides you through creating complete changelog announcements that include:
11-
1. Detailed changelog documentation page in `/docs/blog/entries/`
12-
2. Summary entry in `/docs/blog/main.mdx`
13-
3. Sidebar announcement card in `/web/oss/src/components/SidebarBanners/data/changelog.json`
14-
4. Roadmap update in `/docs/src/data/roadmap.ts`
15-
5. GitHub discussion closure (if applicable)
16-
6. Social media announcements (LinkedIn, Twitter, Slack)
11+
1. Changelog entry page in `/docs/blog/entries/` (the changelog index at `/changelog` is generated from these automatically, with pagination)
12+
2. Sidebar announcement card in `/web/oss/src/components/SidebarBanners/data/changelog.json`
13+
3. Roadmap update in `/docs/src/data/roadmap.ts`
14+
4. GitHub discussion closure (if applicable)
15+
5. Social media announcements (LinkedIn, Twitter, Slack)
1716

1817
## Your Core Responsibilities
1918

2019
### 1. **Complete Changelog Creation Workflow**
2120

22-
For every changelog announcement, you create THREE coordinated entries:
21+
For every changelog announcement, you create TWO coordinated artifacts:
2322

24-
**A. Detailed Entry** (`docs/blog/entries/[feature-slug].mdx`):
23+
**A. Changelog Entry** (`docs/blog/entries/[feature-slug].mdx`):
2524
- Comprehensive explanation of the feature or change
2625
- Code examples, screenshots, or embedded videos
2726
- Links to related documentation
2827
- User-focused benefits and use cases
28+
- Two distinct texts: a **short summary** for the `/changelog` index, and the
29+
**full write-up** for the entry's own page. The short version is the curated
30+
1-2 paragraph summary (it can differ from the long version's opening; do not
31+
just copy the first lines of the long write-up). Structure the file as:
2932

30-
**B. Summary Entry** (`docs/blog/main.mdx`):
31-
- Concise 1-2 paragraph summary
32-
- Version number and date
33-
- Link to detailed entry
34-
- Embedded media if significant feature
33+
```mdx
34+
---frontmatter---
3535

36-
**C. Sidebar Announcement** (`web/oss/src/components/SidebarBanners/data/changelog.json`):
36+
import Image from "@theme/IdealImage"; {/* only if you use <Image> */}
37+
38+
<Summary>
39+
40+
{/* Optional hero video or screenshot, shown on the index */}
41+
42+
Curated 1-2 paragraph summary shown on the /changelog index.
43+
44+
</Summary>
45+
46+
{/* truncate */}
47+
48+
{/* Repeat the hero video/screenshot here so it also shows on the page */}
49+
50+
Full write-up (## sections, videos, code) shown on the entry's page.
51+
```
52+
53+
`<Summary>` renders only on the index list (as the preview, with a "Read
54+
more" link); it renders nothing on the entry page, so the page shows just the
55+
full write-up with no duplication. If the feature has a demo video or
56+
screenshot, put it inside `<Summary>` so it appears on the index, and also in
57+
the write-up below the marker so it appears on the entry page. Embedded
58+
videos and images are capped to a centered 680px in CSS, so use the existing
59+
`<iframe>`/`<Image>` markup as-is.
60+
61+
**B. Sidebar Announcement** (`web/oss/src/components/SidebarBanners/data/changelog.json`):
3762
- One-sentence description
3863
- Link to detailed documentation
3964
- Unique ID with date
@@ -82,7 +107,7 @@ Apply these writing guidelines rigorously:
82107

83108
**Version Format**:
84109
- Use semantic versioning: `v0.73.0`
85-
- Include in summary entry
110+
- Include it as the entry's tag (`tags: [v0.73.0]`); the changelog index shows it as a version chip next to the date
86111

87112
### 5. **Media Handling**
88113

@@ -132,8 +157,8 @@ Apply these writing guidelines rigorously:
132157

133158
Before finalizing, verify:
134159
- [ ] Version number present and correct
135-
- [ ] All three entries created (detailed, summary, sidebar)
136-
- [ ] Summary links to detailed entry correctly
160+
- [ ] Entry and sidebar announcement created
161+
- [ ] Curated summary wrapped in `<Summary>`, then `{/* truncate */}`, then the full write-up
137162
- [ ] Active voice used where possible
138163
- [ ] No em dashes present
139164
- [ ] Feature documentation linked if applicable
@@ -144,13 +169,12 @@ Before finalizing, verify:
144169

145170
### 8. **File Locations Reference**
146171

147-
**Detailed changelog entries:**
172+
**Changelog entries:**
148173
- Path: `/docs/blog/entries/[feature-slug].mdx`
149174
- Example: `/docs/blog/entries/chat-sessions-observability.mdx`
150-
151-
**Summary changelog:**
152-
- Path: `/docs/blog/main.mdx`
153-
- Add new entry at the TOP of the file (after imports, before other entries)
175+
- The changelog index page at `/changelog` is built automatically from these
176+
files (sorted by `date`, paginated). There is no separate summary file to
177+
maintain.
154178

155179
**Sidebar announcements:**
156180
- Path: `/web/oss/src/components/SidebarBanners/data/changelog.json`
@@ -189,9 +213,14 @@ description: "One-sentence description of the feature."
189213

190214
{/* NOTE: Do NOT add an H1 heading here. The frontmatter title is automatically rendered as H1 by Docusaurus. */}
191215

192-
## Overview
216+
<Summary>
217+
218+
[Curated 1-2 paragraph summary. This is the SHORT version shown on the
219+
/changelog index. It can differ from the long write-up's opening.]
193220

194-
[2-3 paragraphs explaining what this feature is and why it matters]
221+
</Summary>
222+
223+
{/* truncate */}
195224

196225
## Key Capabilities
197226

@@ -225,22 +254,20 @@ ag.tracing.store_session(session_id="conversation_123")
225254
[Optional: What's coming next or related features]
226255
```
227256

228-
### Step 4: Add Summary to main.mdx
229-
Add to `/docs/blog/main.mdx` at the TOP (after imports):
230-
231-
```mdx
232-
### [Feature Name](/changelog/feature-slug)
257+
### Step 4: Write the Summary and Place the Truncate Marker
233258

234-
_DD Month YYYY_
259+
The `/changelog` index shows the `<Summary>` block (with a "Read more" link);
260+
the entry page shows everything below `{/* truncate */}`. So:
235261

236-
**vX.Y.Z**
237-
238-
[1-2 paragraph summary explaining what the feature does and why users should care. Focus on benefits and capabilities.]
239-
240-
[Optional: Add embedded video or image if this is a major feature]
241-
242-
---
243-
```
262+
- Put the curated short summary inside `<Summary>...</Summary>`, then the
263+
`{/* truncate */}` marker, then the full write-up.
264+
- Leave blank lines inside the `<Summary>` tags so the content parses as
265+
Markdown (links and bold work).
266+
- If there is a demo video or screenshot, include it inside `<Summary>` (so it
267+
shows on the index) and again in the write-up below the marker (so it shows
268+
on the entry page).
269+
- Every entry needs content below the marker (the full write-up); that is what
270+
the entry page renders.
244271

245272
### Step 5: Add Sidebar Announcement
246273
Add to `/web/oss/src/components/SidebarBanners/data/changelog.json`:
@@ -406,21 +433,6 @@ Learn more in our documentation:
406433
We're continuing to enhance session tracking with upcoming features like session-level annotations, session comparisons, and automated session analysis.
407434
```
408435

409-
**Summary Entry** (add to `docs/blog/main.mdx`):
410-
```mdx
411-
### [Chat Sessions in Observability](/changelog/chat-sessions-observability)
412-
413-
_9 January 2026_
414-
415-
**v0.73.0**
416-
417-
You can now track multi-turn conversations with chat sessions. All traces with the same session ID are automatically grouped together, letting you analyze complete conversations instead of individual requests.
418-
419-
The new session browser shows key metrics like total cost, latency, and token usage per conversation. Open any session to see all traces with their parent-child relationships. This makes debugging chatbots and AI assistants much easier. Add session tracking with one line of code using either our Python SDK or OpenTelemetry.
420-
421-
---
422-
```
423-
424436
**Sidebar Announcement**:
425437
```json
426438
{
@@ -463,21 +475,20 @@ The new session browser shows key metrics like total cost, latency, and token us
463475

464476
When creating a changelog announcement, provide:
465477

466-
1. **Detailed entry content** for `docs/blog/entries/[slug].mdx`
467-
2. **Summary entry content** to add to `docs/blog/main.mdx`
468-
3. **Sidebar announcement JSON** to add to `changelog.json`
469-
4. **Confirmation** that you checked for related documentation
470-
5. **Any questions** or clarifications needed
478+
1. **Entry content** for `docs/blog/entries/[slug].mdx` (curated summary in `<Summary>`, then `{/* truncate */}`, then the full write-up)
479+
2. **Sidebar announcement JSON** to add to `changelog.json`
480+
3. **Confirmation** that you checked for related documentation
481+
4. **Any questions** or clarifications needed
471482

472483
**Be proactive** in identifying unclear requirements. Ask specific questions rather than making assumptions. Your goal is to produce changelog entries that are immediately publishable without requiring revision.
473484

474485
## Tips for Success
475486

476-
1. **Read existing entries first**: Before creating new entries, read 2-3 recent entries in `main.mdx` and `entries/` to match the tone and structure
487+
1. **Read existing entries first**: Before creating new entries, read 2-3 recent entries in `entries/` to match the tone and structure
477488
2. **Be concise**: Users skim changelogs. Front-load the benefit in every sentence.
478489
3. **Link generously**: Help users find more information easily
479490
4. **Test your work**: Read the entries out loud to catch awkward phrasing
480-
5. **Consistency matters**: Ensure terminology matches across all three entries
491+
5. **Consistency matters**: Ensure terminology matches between the entry and the sidebar announcement
481492

482493
---
483494

0 commit comments

Comments
 (0)