Skip to content

docs: 更新文档至 v0.6.1(覆盖 v0.4.2-v0.6.1 全量检查)#1

Open
tesgth032 wants to merge 4 commits intoding113:mainfrom
tesgth032:docs/update-v0.6.0-v0.6.1
Open

docs: 更新文档至 v0.6.1(覆盖 v0.4.2-v0.6.1 全量检查)#1
tesgth032 wants to merge 4 commits intoding113:mainfrom
tesgth032:docs/update-v0.6.0-v0.6.1

Conversation

@tesgth032
Copy link

@tesgth032 tesgth032 commented Feb 28, 2026

Summary

全量检查 v0.4.2 ~ v0.6.1 所有版本变更,更新文档覆盖。

Commit 1: 初始更新(v0.5.3 ~ v0.6.1)

新增文档

  • Langfuse LLM 可观测性集成 (system/langfuse/page.md)

更新内容(14 个文件)

  • changelog: v0.5.3 ~ v0.6.1 全部版本记录
  • env-variables: ENABLE_ENDPOINT_CIRCUIT_BREAKER、Langfuse 系列、Fetch 超时默认值更新
  • system/webhook: 缓存率异常告警
  • system/data-import-export: ledgerOnly 导出、v0.6.0 备份兼容性警告
  • providers/crud: active_time_start/active_time_end 定时启停
  • providers/batch-operations: v0.6.0 重构与撤销
  • users/login-control: v0.6.0 鉴权重构 + v0.6.1 CSRF 修复
  • users/access-restrictions: 客户端限制重构与 blockedClients
  • proxy/cache-ttl: Swap 缓存 TTL 计费
  • monitoring/logs: 决策链溯源
  • page.md: 首页更新
  • navigation.ts: Langfuse 导航项
  • reference/provider-types: 移除不存在的 ENABLE_MULTI_PROVIDER_TYPES 引用

Commit 2: 全量补充(v0.4.2 ~ v0.6.1 覆盖检查)

reference/provider-fields/page.md(+192 行)

  • Anthropic 参数覆写(anthropicMaxTokensPreference、anthropicThinkingBudgetPreference)(v0.5.3)
  • Anthropic Adaptive Thinking(anthropicAdaptiveThinking)(v0.5.5)
  • Gemini Google Search 偏好(geminiGoogleSearchPreference)(v0.5.4)
  • 供应商按组优先级(groupPriorities)(v0.5.5)
  • 定时启停(activeTimeStart/activeTimeEnd)(v0.6.0)
  • 客户端限制(allowedClients/blockedClients)(v0.6.0)
  • 交换缓存 TTL 计费(swapCacheTtlBilling)(v0.6.0)

reference/env-variables/page.md(+197 行)

  • API Key 安全配置节:ENABLE_API_KEY_VACUUM_FILTER、ENABLE_API_KEY_REDIS_CACHE、API_KEY_AUTH_CACHE_TTL_SECONDS
  • 端点探测配置节:ENDPOINT_PROBE_INTERVAL_MS、ENDPOINT_PROBE_TIMEOUT_MS、ENDPOINT_PROBE_METHOD、ENDPOINT_PROBE_CONCURRENCY、ENDPOINT_PROBE_LOG_RETENTION_DAYS
  • 高级配置:ENABLE_PROVIDER_CACHE、MESSAGE_REQUEST_WRITE_MODE、DB_POOL_MAX、MAX_RETRY_ATTEMPTS_DEFAULT
  • 新增 STORE_SESSION_RESPONSE_BODY
  • 修正 STORE_SESSION_MESSAGES 描述(v0.5.1 行为变更)

修复预存问题

  • 移除所有对不存在的 ENABLE_MULTI_PROVIDER_TYPES 的引用
  • 修正 STORE_SESSION_MESSAGES 描述

Test plan

  • 本地 bun run build 验证构建无误
  • 检查所有新增/修改的页面渲染正常
  • 验证新增字段文档与源码 schema.ts 一致
  • 确认新增环境变量与 .env.example 一致

Greptile Summary

This PR updates documentation coverage from v0.4.2 to v0.6.1, adding comprehensive documentation for new features and correcting outdated references.

Major additions:

  • New Langfuse integration documentation - Complete guide for LLM observability setup and usage
  • Extensive env variable documentation - Added API Key security (Vacuum Filter, Redis cache), endpoint probe configuration, and Langfuse settings
  • Provider field expansions - Documented Anthropic parameter overrides, Gemini Google Search preferences, group-based priorities, timed scheduling, client restrictions, and swap cache TTL billing

Key corrections:

  • Removed all references to ENABLE_MULTI_PROVIDER_TYPES (no longer required)
  • Updated STORE_SESSION_MESSAGES behavior description to reflect v0.5.1 changes
  • Changed data export API from excludeLogs boolean to mode enum with ledgerOnly option

Version coverage:

  • Changelog entries for v0.5.3, v0.5.4, v0.5.5, v0.5.6, v0.5.7, v0.5.8, v0.6.0, and v0.6.1
  • Breaking change warnings properly highlighted for v0.6.0 auth refactoring and database compatibility
  • Feature version tags consistently applied throughout documentation

The documentation is well-structured, comprehensive, and accurately reflects the application's evolution across these versions.

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk - it's documentation-only with no code changes
  • All changes are documentation updates with no code modifications. The documentation is comprehensive, well-structured, and consistently formatted. All references to deprecated features (ENABLE_MULTI_PROVIDER_TYPES) have been properly removed. Version tags are present and accurate throughout.
  • No files require special attention - all documentation updates are straightforward and accurately document the features introduced in v0.4.2-v0.6.1

Important Files Changed

Filename Overview
src/app/docs/changelog/page.md Added comprehensive changelog entries for v0.5.3-v0.6.1 with new features, optimizations, and bug fixes
src/app/docs/system/langfuse/page.md New comprehensive Langfuse LLM observability integration documentation with setup and usage guidance
src/app/docs/reference/env-variables/page.md Added env variables for API Key security, endpoint probes, Langfuse; removed ENABLE_MULTI_PROVIDER_TYPES section
src/app/docs/reference/provider-fields/page.md Added provider fields: Anthropic overrides, Gemini Google Search, group priorities, timed scheduling, client restrictions
src/app/docs/system/data-import-export/page.md Updated export API from excludeLogs boolean to mode enum; added ledgerOnly mode for v0.6.0 usage_ledger

Last reviewed commit: dd0aa58

更新内容:
- 新增 Langfuse LLM 可观测性集成文档
- 新增 changelog v0.5.3 ~ v0.6.1 全部版本记录
- 新增环境变量:ENABLE_ENDPOINT_CIRCUIT_BREAKER、Langfuse 系列配置
- 更新供应商管理:定时启停字段、批量操作撤销功能
- 更新 Webhook 通知:缓存率异常告警
- 更新数据导入导出:ledgerOnly 仅账本导出
- 更新用户管理:客户端限制重构、登录鉴权重构说明
- 更新代理设置:Swap 缓存 TTL 计费说明
- 更新监控日志:决策链溯源
- 修复:移除不存在的 ENABLE_MULTI_PROVIDER_TYPES 环境变量引用
- 更新 FETCH_BODY_TIMEOUT/FETCH_HEADERS_TIMEOUT 默认值
@coderabbitai
Copy link

coderabbitai bot commented Feb 28, 2026

📝 Walkthrough

Walkthrough

该 PR 主要为文档与导航更新:新增 v0.6.1/0.6.0 发布说明、Langfuse 集成页面与导航项,扩展环境变量与提供者字段(定时启停、groupPriorities、缓存 TTL 计费、批量撤销、ledgerOnly 导出、缓存率告警、客户端黑名单等)。仅文档与一处导航变更,无运行逻辑修改。

Changes

Cohort / File(s) Summary
发布说明
src/app/docs/changelog/page.md
在变更日志顶部新增 v0.6.1 发布条目(包含 HTTP 部署下 CSRF/login 修复与 X-Forwarded-Host 回退机制),并保留 v0.6.0 说明。
Langfuse 集成与导航
src/app/docs/system/langfuse/page.md, src/lib/navigation.ts, src/app/docs/reference/env-variables/page.md
新增 Langfuse 文档页;在“系统设置”导航添加 Langfuse 链接;环境变量文档新增/扩展 LANGFUSE_* 配置项与说明。
环境变量与运行配置
src/app/docs/reference/env-variables/page.md
重组并新增多项配置(API Key 安全、端点熔断/探测、FETCH 超时调整、会话/消息存储、STORE_SESSION_* 等),更新示例与布尔值处理说明。
提供者字段与调度
src/app/docs/reference/provider-fields/page.md, src/app/docs/providers/crud/page.md
新增 groupPriorities 文档与按组优先级规则;增加 active_time_start / active_time_end 定时启停字段与说明;扩展 Anthropic/Gemini 特定配置说明。
批量操作与撤销
src/app/docs/providers/batch-operations/page.md, src/app/docs/providers/crud/page.md
说明批量更新支持所有可编辑字段;批量删除/编辑新增 5 秒撤销窗口并改为软删除行为,替换原不可恢复表述。
缓存计费与告警
src/app/docs/proxy/cache-ttl/page.md, src/app/docs/system/webhook/page.md
新增交换缓存 TTL 计费说明;Webhook 文档增加“缓存率异常告警”事件类型及触发/消息说明。
导入/导出与账单
src/app/docs/system/data-import-export/page.md
导出接口改为支持 `mode=full
监控与日志
src/app/docs/monitoring/logs/page.md, src/app/docs/page.md
日志字段表新增“决策链溯源 / origin chain”;主文档移除多提供商类型开关提示,新增决策链追溯与 Langfuse 集成监控条目。
访问限制与客户端检测
src/app/docs/users/access-restrictions/page.md
新增 blockedClients 黑名单字段说明并扩展 Claude Code 子客户端自动检测描述(含示例)。
登录控制与兼容性提示
src/app/docs/users/login-control/page.md, src/app/docs/changelog/page.md
登录控制页新增 v0.6.0 安全重构需重新登录说明及 v0.6.1 CSRF/login 修复注记(文档说明)。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确总结了PR的主要变更:全量检查并更新文档以覆盖 v0.4.2 至 v0.6.1 的版本变更,与raw_summary和pr_objectives中的多个文件更新内容相符。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed PR 描述详细关联了所有文档变更的内容,包括新增 Langfuse 文档、环境变量更新、提供商字段扩展等,与代码变更内容高度相关。

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

此拉取请求旨在将文档更新至 v0.6.0 和 v0.6.1 版本,详细记录了自 v0.5.3 以来的所有新功能、优化和修复。核心更新包括引入 Langfuse LLM 可观测性集成,增强了系统监控和追踪能力,并对供应商管理、数据处理和用户认证等多个模块进行了功能扩展和安全性改进,确保文档与最新版本的功能保持一致。

Highlights

  • Langfuse LLM 可观测性集成: 新增了 Langfuse LLM 可观测性集成文档,提供完整的配置指南、架构说明与使用方法,支持端到端请求追踪和可配置采样率。
  • 文档版本更新: 更新了 changelog 文件,详细记录了从 v0.5.3 到 v0.6.1 的所有版本变更,包括新功能、优化和修复。
  • 环境变量与配置: 引入了新的环境变量,如 ENABLE_ENDPOINT_CIRCUIT_BREAKER 用于控制熔断器,以及一系列 Langfuse 相关的配置。同时,更新了 FETCH_BODY_TIMEOUTFETCH_HEADERS_TIMEOUT 的默认值,并移除了已不存在的 ENABLE_MULTI_PROVIDER_TYPES 引用。
  • 系统功能增强: 在 Webhook 通知中新增了缓存率异常告警类型;数据导入导出功能增加了 ledgerOnly 参数,并提示了 v0.6.0 备份不兼容的变更;供应商管理新增了 active_time_startactive_time_end 字段,支持定时启停功能。
  • 用户与权限管理: 重构了供应商批量操作,支持撤销功能;更新了用户登录控制文档,说明了 v0.6.0 鉴权重构和 v0.6.1 CSRF 修复;客户端访问限制功能也进行了重构,新增了 blockedClients 黑名单机制。
  • 导航与首页更新: 导航栏新增了 Langfuse 集成入口,首页也更新了 Langfuse 和决策链功能介绍。
Changelog
  • src/app/docs/changelog/page.md
    • 新增了 v0.6.1、v0.6.0、v0.5.8、v0.5.7、v0.5.6、v0.5.5、v0.5.4 和 v0.5.3 版本的更新记录。
  • src/app/docs/monitoring/logs/page.md
    • 新增了决策链溯源功能的说明。
  • src/app/docs/page.md
    • 新增了 Langfuse 和决策链功能介绍。
    • 移除了关于 ENABLE_MULTI_PROVIDER_TYPES 环境变量的说明。
  • src/app/docs/providers/batch-operations/page.md
    • 新增了 v0.6.0 批量操作重构和撤销功能的说明。
    • 更新了批量操作支持的字段和删除操作的撤销说明。
  • src/app/docs/providers/crud/page.md
    • 新增了 active_time_startactive_time_end 字段及其定时启停功能的说明。
  • src/app/docs/proxy/cache-ttl/page.md
    • 新增了交换缓存 TTL 计费选项的说明。
  • src/app/docs/reference/env-variables/page.md
    • 新增了 ENABLE_ENDPOINT_CIRCUIT_BREAKER 环境变量的说明。
    • 新增了 Langfuse 可观测性相关的环境变量(LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY, LANGFUSE_BASE_URL, LANGFUSE_SAMPLE_RATE, LANGFUSE_DEBUG)。
    • 更新了 FETCH_BODY_TIMEOUTFETCH_HEADERS_TIMEOUT 的默认值。
    • 移除了 ENABLE_MULTI_PROVIDER_TYPES 环境变量的说明。
  • src/app/docs/reference/provider-types/page.md
    • 移除了所有关于 ENABLE_MULTI_PROVIDER_TYPES 环境变量的引用。
  • src/app/docs/system/data-import-export/page.md
    • 新增了 ledgerOnly 参数的说明。
    • 新增了 v0.6.0 数据库备份不兼容的警告。
  • src/app/docs/system/langfuse/page.md
    • 新增了 Langfuse 集成功能的完整文档。
  • src/app/docs/system/webhook/page.md
    • 新增了缓存率异常告警通知类型的说明。
  • src/app/docs/users/access-restrictions/page.md
    • 新增了 v0.6.0 客户端限制重构和 blockedClients 字段的说明。
  • src/app/docs/users/login-control/page.md
    • 新增了 v0.6.0 鉴权重构和 v0.6.1 CSRF 修复的说明。
  • src/lib/navigation.ts
    • 新增了 Langfuse 集成页面的导航项。
Activity
  • 目前没有提供关于此拉取请求的任何活动(例如评论、审查或进度更新)。
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

本次 PR 主要更新了文档以适配 v0.6.0 和 v0.6.1 版本,包括添加了完整的更新日志、记录了 Langfuse 集成等新功能,并清理了过时的引用。整体变更内容详实、组织良好。我发现了一些文档中的细微不一致之处,修正后可以提升文档的清晰度。总的来说,这是一次很棒的贡献,有助于保持文档的实时性。


### 新增

- 扩展只读密钥访问权限,支持更多 API 端点访问 (#704) [@AptS:1547](https://github.com/AptS1547)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

贡献者 [@AptS:1547] 的标注格式看起来有些不寻常。为了与其他贡献者(如 [@NieiR])的标注格式保持一致并提高可读性,建议将其修改为标准的 GitHub handle 格式。

Suggested change
- 扩展只读密钥访问权限,支持更多 API 端点访问 (#704) [@AptS:1547](https://github.com/AptS1547)
- 扩展只读密钥访问权限,支持更多 API 端点访问 (#704) [@AptS1547](https://github.com/AptS1547)

| 性能指标 | `durationMs`, `ttfbMs` | 总耗时和首字节时间 |
| 错误信息 | `errorMessage`, `errorStack`, `errorCause`, `statusCode` | 错误详情、堆栈、原因和 HTTP 状态码 |
| 供应商决策 | `providerChain` | 供应商选择决策链(JSONB) |
| 决策链溯源 | origin chain | 被复用请求可查看 Session 原始决策过程(v0.6.0+) |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

在此表格中,字段名 origin chain 的格式与同一表格中的其他字段(如 providerChaindurationMs)不一致,后者遵循 camelCase 命名规范。为了保持文档的一致性,建议将 origin chain 修改为 originChain

Suggested change
| 决策链溯源 | origin chain | 被复用请求可查看 Session 原始决策过程(v0.6.0+) |
| 决策链溯源 | originChain | 被复用请求可查看 Session 原始决策过程(v0.6.0+) |

```
客户端请求
创建 Langfuse Trace(关联 request-id、user-id、model 等元数据)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

在请求追踪流程的描述中,元数据 request-iduser-id 的命名风格不一致,并且与其他文档中常见的 camelCase 风格(如 userId)也不一致。为了提高文档的统一性和清晰度,建议将它们修改为 requestIduserId

Suggested change
创建 Langfuse Trace(关联 request-id、user-id、model 等元数据)
创建 Langfuse Trace(关联 requestId、userId、model 等元数据)

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
src/app/docs/monitoring/logs/page.md (1)

62-62: 中文语法建议(可选)

静态分析工具提示第 62 行的表述"被复用请求可查看"可能存在语法问题,建议改为"可被复用的请求查看"或"复用的请求可以查看"。不过,原文在上下文中是可以理解的,此建议仅供参考。

类似的提示也出现在第 712 行的"被复用的请求还可以"。

如果您认为当前表述已足够清晰,可以忽略此建议。

📝 可选的改写方案

第 62 行:

-| 决策链溯源 | origin chain | 被复用请求可查看 Session 原始决策过程(v0.6.0+) |
+| 决策链溯源 | origin chain | 复用的请求可以查看 Session 原始决策过程(v0.6.0+) |

第 712 行:

-A: 使用 Session ID 筛选,按时间排序。查看 `requestSequence` 了解请求顺序,`providerChain` 了解供应商选择过程。自 v0.6.0 起,被复用的请求还可以通过决策链溯源功能查看 Session 的原始决策过程。
+A: 使用 Session ID 筛选,按时间排序。查看 `requestSequence` 了解请求顺序,`providerChain` 了解供应商选择过程。自 v0.6.0 起,复用的请求还可以通过决策链溯源功能查看 Session 的原始决策过程。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/monitoring/logs/page.md` at line 62, Update the Chinese wording
in the markdown table cell that currently reads "被复用请求可查看 Session
原始决策过程(v0.6.0+)" to a grammatically clearer form such as "复用的请求可以查看 Session
原始决策过程(v0.6.0+)" (and likewise change the similar phrase at the other occurrence
"被复用的请求还可以" to "复用的请求还可以" or "可被复用的请求还可以") so both the table entry containing
"决策链溯源 | origin chain | 被复用请求可查看 Session 原始决策过程(v0.6.0+)" and the later
occurrence with "被复用的请求还可以" use the improved phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/app/docs/changelog/page.md`:
- Around line 79-236: Update the version headings that currently use the plain
"## vX.Y.Z (YYYY-MM-DD)" format (e.g. "## v0.5.8 (2026-02-15)", "## v0.5.7
(2026-02-14)", "## v0.5.6 (2026-02-12)", "## v0.5.5 (2026-02-11)", "## v0.5.4
(2026-02-07)", "## v0.5.3 (2026-02-03)") to the clickable release link format
shown elsewhere: "## [vX.Y.Z](release-url) - YYYY-MM-DD" (replace release-url
with the actual release permalink and keep the original date after a hyphen),
ensuring every version heading follows this unified pattern.
- Line 161: The changelog entry "Vacuum Filter has 热路径性能优化,降低 API Key 负向短路成本
(`#757`) [`@tesgth032`]" mixes English and Chinese awkwardly; replace that exact
line with a coherent phrasing—either fully Chinese (e.g., "Vacuum Filter
在热路径上进行了性能优化,降低 API Key 触发的负向短路成本") or a clear bilingual sentence (e.g., "Vacuum
Filter: hot-path performance optimizations, reducing API Key negative
short‑circuit cost") so the wording flows naturally.

In `@src/app/docs/providers/crud/page.md`:
- Line 41: 当前文件中出现的标记 "{% /table %}" 表示此处可能是表格结束或表格行被误写;如果这是表格行,请把该行改为与表格其它行一致的
Markdown 表格格式——以竖线开头和结尾并包含 3 列(例如 "| col1 | col2 | col3 |"),保证列数与表头分隔行一致;如果 "{%
/table %}" 是表格结束标记,请恢复为正确的结束标记并检查前一行是否为合法的表格行(补上缺失的前导/尾随管道符和缺失的列分隔符)以修复列数不匹配问题。

In `@src/app/docs/reference/env-variables/page.md`:
- Around line 478-485: Update the table entry for the `true` value so it
explicitly states the switch affects both provider-type-level and endpoint-level
circuit breakers (e.g., "启用供应商类型级和端点级熔断器,连续失败的端点/供应商会被临时屏蔽(默认 3 次失败后熔断 5 分钟)")
and keep the existing {% callout type="note" %} text but remove redundant
phrasing so both places consistently say "双层生效:供应商类型级和端点级". Apply this change by
editing the table row containing `true` and the callout block to use the unified
wording.

In `@src/app/docs/system/langfuse/page.md`:
- Around line 78-90: The fenced code block in
src/app/docs/system/langfuse/page.md is missing a language identifier which can
trigger markdownlint MD040; update the fenced block starting at the diagram so
it explicitly specifies a language (e.g., change the opening fence from ``` to
```text) to silence the lint warning and ensure consistent rendering.

In `@src/app/docs/users/access-restrictions/page.md`:
- Line 113: 在文档中已新增字段 blockedClients,但未在 USER_FIELD_PERMISSIONS
和示例验证规则中同步补全,导致前后不一致;请在 USER_FIELD_PERMISSIONS 的权限映射中为 blockedClients
添加相应权限条目(例如 read/write/deny 等与其它字段一致的权限配置),并在校验规则示例(validation rules)中加入
blockedClients 的类型与约束说明(如 string[]、项格式或长度限制、必填/可选规则),确保字段名为 blockedClients
并与已有字段的示例格式保持一致以避免歧义。

---

Nitpick comments:
In `@src/app/docs/monitoring/logs/page.md`:
- Line 62: Update the Chinese wording in the markdown table cell that currently
reads "被复用请求可查看 Session 原始决策过程(v0.6.0+)" to a grammatically clearer form such as
"复用的请求可以查看 Session 原始决策过程(v0.6.0+)" (and likewise change the similar phrase at
the other occurrence "被复用的请求还可以" to "复用的请求还可以" or "可被复用的请求还可以") so both the
table entry containing "决策链溯源 | origin chain | 被复用请求可查看 Session 原始决策过程(v0.6.0+)"
and the later occurrence with "被复用的请求还可以" use the improved phrasing.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to Reviews > Disable Cache setting

📥 Commits

Reviewing files that changed from the base of the PR and between 13ff9c3 and 00fe18e.

📒 Files selected for processing (14)
  • src/app/docs/changelog/page.md
  • src/app/docs/monitoring/logs/page.md
  • src/app/docs/page.md
  • src/app/docs/providers/batch-operations/page.md
  • src/app/docs/providers/crud/page.md
  • src/app/docs/proxy/cache-ttl/page.md
  • src/app/docs/reference/env-variables/page.md
  • src/app/docs/reference/provider-types/page.md
  • src/app/docs/system/data-import-export/page.md
  • src/app/docs/system/langfuse/page.md
  • src/app/docs/system/webhook/page.md
  • src/app/docs/users/access-restrictions/page.md
  • src/app/docs/users/login-control/page.md
  • src/lib/navigation.ts

| `group_tag` | 分组标签 | "production", "backup" |
| `active_time_start` | 定时启动时间(HH:mm 格式)| "08:00"(v0.6.0+) |
| `active_time_end` | 定时停止时间(HH:mm 格式)| "22:00"(v0.6.0+) |
{% /table %}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

修复表格格式问题

静态分析工具检测到第 41 行存在表格格式问题:缺少前导和尾随管道符(|),且列数不匹配(预期 3 列,实际 1 列)。请检查该行是否为表格的一部分,如果是,请确保其格式与表格其他行一致。

🔧 可能的修复方案

如果第 41 行应该是表格的一部分,请确保格式如下:

 | `active_time_end` | 定时停止时间(HH:mm 格式)| "22:00"(v0.6.0+) |
-{% /table %}
+{% /table %}

如果第 41 行是表格结束标记,请确保上一行(第 40 行)的表格行格式正确。

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 41-41: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe

(MD055, table-pipe-style)


[warning] 41-41: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe

(MD055, table-pipe-style)


[warning] 41-41: Table column count
Expected: 3; Actual: 1; Too few cells, row will be missing data

(MD056, table-column-count)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/providers/crud/page.md` at line 41, 当前文件中出现的标记 "{% /table %}"
表示此处可能是表格结束或表格行被误写;如果这是表格行,请把该行改为与表格其它行一致的 Markdown 表格格式——以竖线开头和结尾并包含 3 列(例如 "|
col1 | col2 | col3 |"),保证列数与表头分隔行一致;如果 "{% /table %}"
是表格结束标记,请恢复为正确的结束标记并检查前一行是否为合法的表格行(补上缺失的前导/尾随管道符和缺失的列分隔符)以修复列数不匹配问题。

Comment on lines 478 to 485
| 值 | 行为 |
|------|------|
| `false` | 仅支持 `claude`、`claude-auth`、`codex` |
| `true` | 额外支持 `gemini`、`gemini-cli`、`openai-compatible` |
| `false` | 禁用端点熔断器,所有启用的端点均可使用 |
| `true` | 启用端点熔断器,连续失败的端点会被临时屏蔽(默认 3 次失败后熔断 5 分钟) |

{% callout type="warning" title="实验性功能" %}
Gemini CLI、OpenAI Compatible 等类型功能仍在开发中,可能存在不稳定性。
生产环境暂不建议启用。
{% callout type="note" %}
此开关同时控制供应商类型级别和端点级别的熔断器。启用后,供应商类型和端点的熔断器都会生效。
{% /callout %}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

开关行为描述前后不完全一致,建议在值表中直接说明“双层生效范围”。

Line 480-481 仅描述“端点级”,但 Line 484-485 说明该开关同时影响“供应商类型级 + 端点级”。建议合并表达,减少误解。

✏️ 建议修改
-| `false` | 禁用端点熔断器,所有启用的端点均可使用 |
-| `true` | 启用端点熔断器,连续失败的端点会被临时屏蔽(默认 3 次失败后熔断 5 分钟) |
+| `false` | 禁用供应商类型级与端点级熔断器,所有启用端点按常规参与路由 |
+| `true` | 启用供应商类型级与端点级熔断器;连续失败的端点会被临时屏蔽(默认 3 次失败后熔断 5 分钟) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/reference/env-variables/page.md` around lines 478 - 485, Update
the table entry for the `true` value so it explicitly states the switch affects
both provider-type-level and endpoint-level circuit breakers (e.g.,
"启用供应商类型级和端点级熔断器,连续失败的端点/供应商会被临时屏蔽(默认 3 次失败后熔断 5 分钟)") and keep the existing {%
callout type="note" %} text but remove redundant phrasing so both places
consistently say "双层生效:供应商类型级和端点级". Apply this change by editing the table row
containing `true` and the callout block to use the unified wording.

```typescript
{
allowedClients: string[], // 允许的客户端模式列表
blockedClients: string[], // 拒绝的客户端模式列表(v0.6.0+)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

请同步补全 blockedClients 的权限与校验示例,避免文档前后不一致。

当前已在字段定义里引入 blockedClients,但后文 USER_FIELD_PERMISSIONS 和验证规则示例仍未体现该字段,容易误导实施者。建议在这两个代码片段中补上 blockedClients

✏️ 建议补充示例
 export const USER_FIELD_PERMISSIONS = {
   allowedClients: { requiredRole: "admin" },
+  blockedClients: { requiredRole: "admin" },
   allowedModels: { requiredRole: "admin" },
   // ...
 };
 allowedClients: z
   .array(z.string().max(64, "客户端模式长度不能超过64个字符"))
   .max(50, "客户端模式数量不能超过50个")
   .optional()
   .default([]),

+blockedClients: z
+  .array(z.string().max(64, "客户端模式长度不能超过64个字符"))
+  .max(50, "客户端模式数量不能超过50个")
+  .optional()
+  .default([]),
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/users/access-restrictions/page.md` at line 113, 在文档中已新增字段
blockedClients,但未在 USER_FIELD_PERMISSIONS 和示例验证规则中同步补全,导致前后不一致;请在
USER_FIELD_PERMISSIONS 的权限映射中为 blockedClients 添加相应权限条目(例如 read/write/deny
等与其它字段一致的权限配置),并在校验规则示例(validation rules)中加入 blockedClients 的类型与约束说明(如
string[]、项格式或长度限制、必填/可选规则),确保字段名为 blockedClients 并与已有字段的示例格式保持一致以避免歧义。

reference/provider-fields/page.md:
- 新增 Anthropic 参数覆写章节(anthropicMaxTokensPreference、anthropicThinkingBudgetPreference、anthropicAdaptiveThinking)
- 新增 Gemini Google Search 偏好章节(geminiGoogleSearchPreference)
- 新增供应商按组优先级(groupPriorities)
- 新增定时启停配置(activeTimeStart/activeTimeEnd)
- 新增客户端限制配置(allowedClients/blockedClients)
- 新增交换缓存 TTL 计费(swapCacheTtlBilling)

reference/env-variables/page.md:
- 新增 API Key 安全配置节(ENABLE_API_KEY_VACUUM_FILTER、ENABLE_API_KEY_REDIS_CACHE、API_KEY_AUTH_CACHE_TTL_SECONDS)
- 新增端点探测配置节(ENDPOINT_PROBE_*)
- 新增高级配置变量(ENABLE_PROVIDER_CACHE、MESSAGE_REQUEST_WRITE_MODE、DB_POOL_MAX、MAX_RETRY_ATTEMPTS_DEFAULT)
- 新增 STORE_SESSION_RESPONSE_BODY 变量
- 修正 STORE_SESSION_MESSAGES 描述(v0.5.1 行为变更:控制脱敏而非存储开关)
- 更新概述和生产配置示例
@tesgth032 tesgth032 changed the title docs: 更新文档至 v0.6.0/v0.6.1 [未完成] docs: 更新文档至 v0.6.1(覆盖 v0.4.2-v0.6.1 全量检查)[未完成] Feb 28, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
src/app/docs/reference/provider-fields/page.md (2)

695-709: 交换缓存 TTL 计费文档简洁,可选补充示例。

新增的交换缓存 TTL 计费功能(v0.6.0+)说明简洁明了,清楚解释了解决供应商计费不匹配问题的目的。如需保持与其他章节的一致性,可考虑补充 JSON 配置示例。

📝 可选:补充配置示例
 启用后,在计费计算时将 1 小时和 5 分钟的缓存 TTL 互换,使计费与供应商的实际收费策略对齐。
+
+### 配置示例
+
+```json
+{
+  "swapCacheTtlBilling": true
+}
+```
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/reference/provider-fields/page.md` around lines 695 - 709, Add a
small JSON configuration example and consistent formatting to the "交换缓存 TTL 计费"
section: update the description for the `swapCacheTtlBilling` field to include a
one-line JSON snippet showing how to enable it (e.g., {"swapCacheTtlBilling":
true}) and ensure the example is wrapped as a code block and placed immediately
after the field table so it matches other sections' structure; reference the
`swapCacheTtlBilling` field and the existing section header to find where to
insert the example.

672-693: 客户端限制配置文档可补充示例。

新增的客户端限制配置章节(v0.6.0 重构)包含了字段说明和匹配规则,但与其他章节相比缺少 JSON 配置示例。建议补充示例以保持文档风格一致性,方便管理员理解 allowedClientsblockedClients 的具体配置格式。

📝 建议补充的配置示例
 系统支持自动检测 Claude Code CLI 子客户端(使用 4 信号检测系统),便于精细化控制不同 IDE 集成的访问权限。
+
+### 配置示例
+
+```json
+{
+  "allowedClients": ["vscode", "cursor"],
+  "blockedClients": ["windsurf"]
+}
+```
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/reference/provider-fields/page.md` around lines 672 - 693,
在“客户端限制配置”章节中补充一个 JSON 配置示例来示范 allowedClients 和 blockedClients 的用法;在 page.md
的该节(涉及字段 allowedClients、blockedClients 及匹配规则)添加一个简短的代码块示例,展示 allowedClients
包含允许的客户端(如 "vscode","cursor")并同时包含 blockedClients 黑名单(如
"windsurf"),保持与文档中其他章节示例的格式和风格一致并放在字段说明或匹配规则之后以便阅读。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/app/docs/reference/provider-fields/page.md`:
- Around line 695-709: Add a small JSON configuration example and consistent
formatting to the "交换缓存 TTL 计费" section: update the description for the
`swapCacheTtlBilling` field to include a one-line JSON snippet showing how to
enable it (e.g., {"swapCacheTtlBilling": true}) and ensure the example is
wrapped as a code block and placed immediately after the field table so it
matches other sections' structure; reference the `swapCacheTtlBilling` field and
the existing section header to find where to insert the example.
- Around line 672-693: 在“客户端限制配置”章节中补充一个 JSON 配置示例来示范 allowedClients 和
blockedClients 的用法;在 page.md 的该节(涉及字段 allowedClients、blockedClients
及匹配规则)添加一个简短的代码块示例,展示 allowedClients 包含允许的客户端(如 "vscode","cursor")并同时包含
blockedClients 黑名单(如 "windsurf"),保持与文档中其他章节示例的格式和风格一致并放在字段说明或匹配规则之后以便阅读。

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to Reviews > Disable Cache setting

📥 Commits

Reviewing files that changed from the base of the PR and between 00fe18e and cb9d195.

📒 Files selected for processing (2)
  • src/app/docs/reference/env-variables/page.md
  • src/app/docs/reference/provider-fields/page.md

- 统一 changelog v0.5.3-v0.5.8 标题格式为可点击链接格式
- 修复 v0.5.5 changelog 中 "Vacuum Filter has" 中英混杂问题
- 修复 langfuse/page.md 代码块缺少语言标识符
- 完善 ENABLE_ENDPOINT_CIRCUIT_BREAKER 表格描述,明确双层级影响
- 为客户端限制配置和交换缓存 TTL 计费添加 JSON 配置示例
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
src/app/docs/reference/env-variables/page.md (1)

547-554: 表格与 callout 内容有轻微重复,建议精简。

Line 550 的表格行为描述已提到"供应商类型级别和端点级别的熔断器均生效",Line 552-554 的 callout 再次说明"此开关同时控制供应商类型级别和端点级别的熔断器",存在信息重复。

建议优化:要么在表格中简化描述,要么在 callout 中补充额外信息(如生效机制、使用建议等)。

♻️ 可选优化方案

方案 1:简化表格,让 callout 承载详细说明

 | 值 | 行为 |
 |------|------|
 | `false` | 禁用端点熔断器,所有启用的端点均可使用 |
-| `true` | 启用熔断器,供应商类型级别和端点级别的熔断器均生效,连续失败的端点会被临时屏蔽(默认 3 次失败后熔断 5 分钟) |
+| `true` | 启用熔断器,连续失败的端点会被临时屏蔽(默认 3 次失败后熔断 5 分钟) |

 {% callout type="note" %}
-此开关同时控制供应商类型级别和端点级别的熔断器。启用后,供应商类型和端点的熔断器都会生效。
+此开关同时控制**供应商类型级别**和**端点级别**的熔断器。启用后,系统会在两个层级同时监控失败率:供应商类型层级的熔断可快速屏蔽整类供应商,端点层级的熔断可精细隔离单个故障端点。
 {% /callout %}

方案 2:在 callout 中补充使用建议

 {% callout type="note" %}
-此开关同时控制供应商类型级别和端点级别的熔断器。启用后,供应商类型和端点的熔断器都会生效。
+此开关同时控制供应商类型级别和端点级别的熔断器。启用后,供应商类型和端点的熔断器都会生效。生产环境建议保持关闭(默认),仅在多端点部署且需要精细故障隔离时启用。
 {% /callout %}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/app/docs/reference/env-variables/page.md` around lines 547 - 554, 表格中对
`true` 的行为描述与后面的 {% callout %} 重复;请在表格的该单元(值为 `true`
的行为列)中简化为一句核心信息(例如“启用熔断器(默认:连续 3 次失败后熔断 5 分钟)”),并在 {% callout %}
块中保留/补充详细说明或使用建议(例如生效范围、建议场景或配置提示),以消除冗余并将概要与详述分别放在表格和 callout 中,修改目标为表格的 `true`
行和随后的 {% callout %} 块。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/app/docs/reference/env-variables/page.md`:
- Around line 547-554: 表格中对 `true` 的行为描述与后面的 {% callout %} 重复;请在表格的该单元(值为 `true`
的行为列)中简化为一句核心信息(例如“启用熔断器(默认:连续 3 次失败后熔断 5 分钟)”),并在 {% callout %}
块中保留/补充详细说明或使用建议(例如生效范围、建议场景或配置提示),以消除冗余并将概要与详述分别放在表格和 callout 中,修改目标为表格的 `true`
行和随后的 {% callout %} 块。

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to Reviews > Disable Cache setting

📥 Commits

Reviewing files that changed from the base of the PR and between cb9d195 and d4171b0.

📒 Files selected for processing (4)
  • src/app/docs/changelog/page.md
  • src/app/docs/reference/env-variables/page.md
  • src/app/docs/reference/provider-fields/page.md
  • src/app/docs/system/langfuse/page.md

数据导出 API 实际使用 ?mode=full|excludeLogs|ledgerOnly 参数,
而非独立的 boolean 参数。同时补充 ledger-only 文件命名示例。
@tesgth032 tesgth032 changed the title docs: 更新文档至 v0.6.1(覆盖 v0.4.2-v0.6.1 全量检查)[未完成] docs: 更新文档至 v0.6.1(覆盖 v0.4.2-v0.6.1 全量检查) Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant