From 10a801ce8309741f19700318e76468f41019ce2c Mon Sep 17 00:00:00 2001 From: Ishaan Jaffer Date: Sat, 27 Sep 2025 16:51:58 -0700 Subject: [PATCH] docs fix --- .../RELEASE_NOTES_GENERATION_INSTRUCTIONS.md | 110 +++++++++++++++--- 1 file changed, 95 insertions(+), 15 deletions(-) diff --git a/cookbook/misc/RELEASE_NOTES_GENERATION_INSTRUCTIONS.md b/cookbook/misc/RELEASE_NOTES_GENERATION_INSTRUCTIONS.md index b0a24ef28e9..d47de5b0871 100644 --- a/cookbook/misc/RELEASE_NOTES_GENERATION_INSTRUCTIONS.md +++ b/cookbook/misc/RELEASE_NOTES_GENERATION_INSTRUCTIONS.md @@ -26,7 +26,7 @@ git diff HEAD -- model_prices_and_context_window.json ### 2. Release Notes Structure -Follow this exact structure based on recent stable releases (v1.76.3-stable, v1.77.2-stable): +Follow this exact structure based on recent stable releases (v1.76.3-stable, v1.77.2-stable, v1.77.5-stable): ```markdown --- @@ -41,7 +41,7 @@ hide_table_of_contents: false [Docker and pip installation tabs] ## Key Highlights -[3-5 bullet points of major features] +[3-5 bullet points of major features - prioritize MCP OAuth 2.0, scheduled key rotations, and major model updates] ## New Models / Updated Models #### New Model Support @@ -65,26 +65,32 @@ hide_table_of_contents: false ## Management Endpoints / UI #### Features -[UI and management features] +[UI and management features - group by functionality like Proxy CLI Auth, Virtual Keys, Models + Endpoints] #### Bugs [Management-related bug fixes] -## Logging / Guardrail Integrations +## Logging / Guardrail / Prompt Management Integrations #### Features [Organized by integration provider with proper doc links] #### Guardrails [Guardrail-specific features and fixes] -#### New Integration -[Major new integrations] +#### Prompt Management +[Prompt management integrations like BitBucket] + +## Spend Tracking, Budgets and Rate Limiting +[Cost tracking, service tier pricing, rate limiting improvements] + +## MCP Gateway +[MCP-specific features, OAuth 2.0, configuration improvements] ## Performance / Loadbalancing / Reliability improvements -[Infrastructure improvements] +[Infrastructure improvements, memory fixes, performance optimizations] -## General Proxy Improvements -[Other proxy-related changes] +## Documentation Updates +[Documentation improvements, guides, corrections - separate section for visibility] ## New Contributors [List of first-time contributors] @@ -101,6 +107,11 @@ hide_table_of_contents: false - CPU usage optimizations - Timeout controls - Worker configuration +- Memory leak fixes +- Cache performance improvements +- Database connection management +- Dependency management (fastuuid, etc.) +- Configuration management **New Models/Updated Models:** - Extract from model_prices_and_context_window.json diff @@ -132,20 +143,32 @@ hide_table_of_contents: false - Dashboard improvements - Team management - Key management +- Proxy CLI authentication and improvements +- Virtual key management and scheduled rotations +- SSO configuration fixes +- Admin settings updates +- Management routes and endpoints -**Logging / Guardrail Integrations:** +**Logging / Guardrail / Prompt Management Integrations:** - **Structure:** - `#### Features` - organized by integration provider with proper doc links - `#### Guardrails` - guardrail-specific features and fixes + - `#### Prompt Management` - prompt management integrations - `#### New Integration` - major new integrations - **Integration Categories:** - **[DataDog](../../docs/proxy/logging#datadog)** - group all DataDog-related changes - **[Langfuse](../../docs/proxy/logging#langfuse)** - Langfuse-specific features - **[Prometheus](../../docs/proxy/logging#prometheus)** - monitoring improvements - **[PostHog](../../docs/observability/posthog)** - observability integration + - **[SQS](../../docs/proxy/logging#sqs)** - SQS logging features + - **[Opik](../../docs/proxy/logging#opik)** - Opik integration improvements - Other logging providers with proper doc links +- **Guardrail Categories:** + - LakeraAI, Presidio, Noma, and other guardrail providers +- **Prompt Management:** + - BitBucket, GitHub, and other prompt management integrations - Use bullet points under each provider for multiple features -- Separate logging features from guardrails clearly +- Separate logging features from guardrails and prompt management clearly ### 4. Documentation Linking Strategy @@ -189,15 +212,26 @@ From git diff analysis, create tables like: - `[Perf]`, `Performance`, `RPS` → Performance Improvements - `[Bug]`, `[Bug Fix]`, `Fix` → Bug Fixes section - `[Feat]`, `[Feature]`, `Add support` → Features section -- `[Docs]` → Documentation (usually exclude from main sections) +- `[Docs]` → Documentation Updates section - Provider names (Gemini, OpenAI, etc.) → Group under provider +- `MCP`, `oauth`, `Model Context Protocol` → MCP Gateway +- `service_tier`, `priority`, `cost tracking` → Spend Tracking, Budgets and Rate Limiting **By PR Content Analysis:** - New model additions → New Models section - UI changes → Management Endpoints/UI -- Logging/observability → Logging/Guardrail Integrations -- Rate limiting/budgets → Performance/Reliability -- Authentication → Management Endpoints +- Logging/observability → Logging/Guardrail/Prompt Management Integrations +- Rate limiting/budgets → Spend Tracking, Budgets and Rate Limiting +- Authentication → Management Endpoints/UI +- MCP-related changes → MCP Gateway +- Documentation updates → Documentation Updates +- Performance/memory fixes → Performance/Loadbalancing/Reliability improvements + +**Special Categorization Rules:** +- **Service tier pricing** (OpenAI priority/flex) → Spend Tracking section (NOT provider features) +- **Cost breakdown in logging** → Spend Tracking section +- **MCP configuration/OAuth** → MCP Gateway (NOT General Proxy Improvements) +- **All documentation PRs** → Documentation Updates section for visibility ### 7. Writing Style Guidelines @@ -226,6 +260,18 @@ From git diff analysis, create tables like: - Ensure model pricing is accurate - Confirm provider names are consistent - Review for typos and formatting issues +- **Count PRs by section** - Provide final count like: + ``` + ## MM/DD/YYYY + * New Models / Updated Models: XX + * LLM API Endpoints: XX + * Management Endpoints / UI: XX + * Logging / Guardrail / Prompt Management Integrations: XX + * Spend Tracking, Budgets and Rate Limiting: XX + * MCP Gateway: XX + * Performance / Loadbalancing / Reliability improvements: XX + * Documentation Updates: XX + ``` ### 9. Common Patterns to Follow @@ -295,6 +341,40 @@ This release has a known issue... - Complex configuration options - Migration requirements +### 11. New Sections and Categories (Added in v1.77.5) + +**MCP Gateway Section:** +- All MCP-related changes go here (not in General Proxy Improvements) +- OAuth 2.0 flow improvements +- MCP configuration and tools +- Server management features + +**Spend Tracking, Budgets and Rate Limiting Section:** +- Service tier pricing (OpenAI priority/flex pricing) +- Cost tracking and breakdown features +- Rate limiting improvements (Parallel Request Limiter v3) +- Priority reservation fixes +- Metadata handling for rate limiting + +**Documentation Updates Section:** +- Create separate section for all documentation improvements +- Include provider documentation fixes +- Model reference updates +- New guides and tutorials +- Documentation corrections and clarifications +- This gives documentation changes proper visibility + +**Management Endpoints / UI Grouping:** +- Group related features under sub-categories: + - **Proxy CLI Auth** - CLI authentication improvements + - **Virtual Keys** - Key rotation and management + - **Models + Endpoints** - Provider and endpoint management + +**Logging Section Expansion:** +- Rename to "Logging / Guardrail / Prompt Management Integrations" +- Add **Prompt Management** subsection for BitBucket, GitHub integrations +- Keep guardrails separate from logging features + ## Example Command Workflow ```bash