@@ -4,10 +4,10 @@ This document provides comprehensive instructions for AI agents to generate rele
4
4
5
5
## Required Inputs
6
6
7
- 1 . ** Release Version** (e.g., ` v1.76 .3-stable ` )
7
+ 1 . ** Release Version** (e.g., ` v1.77 .3-stable ` )
8
8
2 . ** PR Diff/Changelog** - List of PRs with titles and contributors
9
9
3 . ** Previous Version Commit Hash** - To compare model pricing changes
10
- 4 . ** Reference Release Notes** - Previous release notes to follow style/format
10
+ 4 . ** Reference Release Notes** - Use recent stable releases (v1.76.3-stable, v1.77.2-stable) as templates for consistent formatting
11
11
12
12
## Step-by-Step Process
13
13
@@ -26,12 +26,12 @@ git diff <previous_commit_hash> HEAD -- model_prices_and_context_window.json
26
26
27
27
### 2. Release Notes Structure
28
28
29
- Follow this exact structure based on ` docs/my-website/release_notes/ v1.76.1 -stable/index.md ` :
29
+ Follow this exact structure based on recent stable releases ( v1.76.3 -stable, v1.77.2-stable) :
30
30
31
31
``` markdown
32
32
---
33
- title: "v1.76 .X-stable - [Key Theme]"
34
- slug: "v1-76 -X"
33
+ title: "v1.77 .X-stable - [Key Theme]"
34
+ slug: "v1-77 -X"
35
35
date: YYYY-MM-DDTHH:mm:ss
36
36
authors: [standard author block]
37
37
hide_table_of_contents: false
@@ -43,23 +43,42 @@ hide_table_of_contents: false
43
43
## Key Highlights
44
44
[3-5 bullet points of major features]
45
45
46
- ## Major Changes
47
- [Critical changes users need to know]
46
+ ## New Models / Updated Models
47
+ #### New Model Support
48
+ [Model pricing table]
48
49
49
- ## Performance Improvements
50
- [Performance-related changes ]
50
+ #### Features
51
+ [Provider-specific features organized by provider ]
51
52
52
- ## New Models / Updated Models
53
- [Detailed model tables and provider updates]
53
+ ### Bug Fixes
54
+ [Provider-specific bug fixes organized by provider]
55
+
56
+ #### New Provider Support
57
+ [New provider integrations]
54
58
55
59
## LLM API Endpoints
56
- [API-related features and fixes]
60
+ #### Features
61
+ [API-specific features organized by API type]
62
+
63
+ #### Bugs
64
+ [General bug fixes]
57
65
58
66
## Management Endpoints / UI
59
- [Admin interface and management changes]
67
+ #### Features
68
+ [UI and management features]
69
+
70
+ #### Bugs
71
+ [Management-related bug fixes]
60
72
61
73
## Logging / Guardrail Integrations
62
- [Observability and security features]
74
+ #### Features
75
+ [Organized by integration provider with proper doc links]
76
+
77
+ #### Guardrails
78
+ [Guardrail-specific features and fixes]
79
+
80
+ #### New Integration
81
+ [Major new integrations]
63
82
64
83
## Performance / Loadbalancing / Reliability improvements
65
84
[Infrastructure improvements]
@@ -86,33 +105,47 @@ hide_table_of_contents: false
86
105
** New Models/Updated Models:**
87
106
- Extract from model_prices_and_context_window.json diff
88
107
- Create tables with: Provider, Model, Context Window, Input Cost, Output Cost, Features
89
- - Group by provider
90
- - Note pricing corrections
91
- - Highlight deprecated models
92
-
93
- ** Provider Features:**
94
- - Group by provider (Gemini, OpenAI, Anthropic, etc.)
95
- - Link to provider docs: ` ../../docs/providers/[provider_name] `
96
- - Separate features from bug fixes
97
-
98
- ** API Endpoints:**
99
- - Images API
100
- - Video Generation (if applicable)
101
- - Responses API
102
- - Passthrough endpoints
103
- - General chat completions
108
+ - ** Structure:**
109
+ - ` #### New Model Support ` - pricing table
110
+ - ` #### Features ` - organized by provider with documentation links
111
+ - ` ### Bug Fixes ` - provider-specific bug fixes
112
+ - ` #### New Provider Support ` - major new provider integrations
113
+ - Group by provider with proper doc links: ` **[Provider Name](../../docs/providers/[provider])** `
114
+ - Use bullet points under each provider for multiple features
115
+ - Separate features from bug fixes clearly
116
+
117
+ ** LLM API Endpoints:**
118
+ - ** Structure:**
119
+ - ` #### Features ` - organized by API type (Responses API, Batch API, etc.)
120
+ - ` #### Bugs ` - general bug fixes under ** General** category
121
+ - ** API Categories:**
122
+ - Responses API
123
+ - Batch API
124
+ - CountTokens API
125
+ - Images API
126
+ - Video Generation (if applicable)
127
+ - General (miscellaneous improvements)
128
+ - Use proper documentation links for each API type
104
129
105
130
** UI/Management:**
106
131
- Authentication changes
107
132
- Dashboard improvements
108
133
- Team management
109
134
- Key management
110
135
111
- ** Integrations:**
112
- - Logging providers (Datadog, Braintrust, etc.)
113
- - Guardrails
114
- - Cost tracking
115
- - Observability
136
+ ** Logging / Guardrail Integrations:**
137
+ - ** Structure:**
138
+ - ` #### Features ` - organized by integration provider with proper doc links
139
+ - ` #### Guardrails ` - guardrail-specific features and fixes
140
+ - ` #### New Integration ` - major new integrations
141
+ - ** Integration Categories:**
142
+ - ** [ DataDog] ( ../../docs/proxy/logging#datadog ) ** - group all DataDog-related changes
143
+ - ** [ Langfuse] ( ../../docs/proxy/logging#langfuse ) ** - Langfuse-specific features
144
+ - ** [ Prometheus] ( ../../docs/proxy/logging#prometheus ) ** - monitoring improvements
145
+ - ** [ PostHog] ( ../../docs/observability/posthog ) ** - observability integration
146
+ - Other logging providers with proper doc links
147
+ - Use bullet points under each provider for multiple features
148
+ - Separate logging features from guardrails clearly
116
149
117
150
### 4. Documentation Linking Strategy
118
151
@@ -211,10 +244,41 @@ This release has a known issue...
211
244
:::
212
245
```
213
246
214
- ** Provider Features:**
247
+ ** Provider Features (New Models / Updated Models section) :**
215
248
``` markdown
249
+ #### Features
250
+
216
251
- **[Provider Name](../../docs/providers/provider)**
217
252
- Feature description - [PR #XXXXX](link)
253
+ - Another feature description - [PR #YYYYY](link)
254
+ ```
255
+
256
+ ** API Features (LLM API Endpoints section):**
257
+ ``` markdown
258
+ #### Features
259
+
260
+ - **[API Name](../../docs/api_path)**
261
+ - Feature description - [PR #XXXXX](link)
262
+ - Another feature - [PR #YYYYY](link)
263
+ - **General**
264
+ - Miscellaneous improvements - [PR #ZZZZZ](link)
265
+ ```
266
+
267
+ ** Integration Features (Logging / Guardrail Integrations section):**
268
+ ``` markdown
269
+ #### Features
270
+
271
+ - **[Integration Name](../../docs/proxy/logging#integration)**
272
+ - Feature description - [PR #XXXXX](link)
273
+ - Bug fix description - [PR #YYYYY](link)
274
+ ```
275
+
276
+ ** Bug Fixes Pattern:**
277
+ ``` markdown
278
+ ### Bug Fixes
279
+
280
+ - **[Provider/Component Name](../../docs/providers/provider)**
281
+ - Bug fix description - [PR #XXXXX](link)
218
282
```
219
283
220
284
### 10. Missing Documentation Check
0 commit comments