From 047fc9bee23c01bd860ded89ddf6b2f704b6bf0c Mon Sep 17 00:00:00 2001 From: Gingiris Date: Tue, 28 Apr 2026 12:18:37 -0700 Subject: [PATCH] docs: add Table of Contents to README.MD and README.en.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Both READMEs are 400+ lines with 14 top-level sections and multiple subsections but have no navigation aid. Add a Table of Contents at the top of each file to help readers quickly find relevant sections. Changes: - README.MD: add 目录 section with links to all h2/h3 headings - README.en.md: add Table of Contents with matching structure --- README.MD | 24 ++++++++++++++++++++++++ README.en.md | 24 ++++++++++++++++++++++++ 2 files changed, 48 insertions(+) diff --git a/README.MD b/README.MD index 3c7b4d9..7c20a7a 100644 --- a/README.MD +++ b/README.MD @@ -31,6 +31,30 @@ > > 请勿将本项目用于违反服务条款、协议、法律法规或平台规则的场景。商业使用前请自行确认 `LICENSE`、相关协议以及你是否获得了作者的书面许可。 +## 目录 + +- [架构概览(摘要)](#架构概览摘要) +- [核心能力](#核心能力) +- [平台兼容矩阵](#平台兼容矩阵) +- [模型支持](#模型支持) + - [OpenAI 接口](#openai-接口get-v1models) + - [Claude 接口](#claude-接口get-anthropicv1models) + - [Gemini 接口](#gemini-接口) +- [快速开始](#快速开始) + - [方式一:下载 Release 构建包](#方式一下载-release-构建包) + - [方式二:Docker 运行](#方式二docker-运行) + - [方式三:Vercel 部署](#方式三vercel-部署) + - [方式四:本地源码运行](#方式四本地源码运行) +- [配置说明](#配置说明) +- [鉴权模式](#鉴权模式) +- [并发模型](#并发模型) +- [Tool Call 适配](#tool-call-适配) +- [本地开发抓包工具](#本地开发抓包工具) +- [文档索引](#文档索引) +- [测试](#测试) +- [Release 自动构建(GitHub Actions)](#release-自动构建github-actions) +- [免责声明](#免责声明) + ## 架构概览(摘要) ```mermaid diff --git a/README.en.md b/README.en.md index 32390e5..4484fcf 100644 --- a/README.en.md +++ b/README.en.md @@ -28,6 +28,30 @@ Documentation entry: [Docs Index](docs/README.md) / [Architecture](docs/ARCHITEC > > Do not use this project in ways that violate service terms, agreements, laws, or platform rules. Before any commercial use, review the `LICENSE`, the relevant terms, and confirm that you have the author's written permission. +## Table of Contents + +- [Architecture Overview (Summary)](#architecture-overview-summary) +- [Key Capabilities](#key-capabilities) +- [Platform Compatibility Matrix](#platform-compatibility-matrix) +- [Model Support](#model-support) + - [OpenAI Endpoint](#openai-endpoint-get-v1models) + - [Claude Endpoint](#claude-endpoint-get-anthropicv1models) + - [Gemini Endpoint](#gemini-endpoint) +- [Quick Start](#quick-start) + - [Option 1: Download Release Binaries](#option-1-download-release-binaries) + - [Option 2: Docker / GHCR](#option-2-docker--ghcr) + - [Option 3: Vercel](#option-3-vercel) + - [Option 4: Local Run](#option-4-local-run) +- [Configuration](#configuration) +- [Authentication Modes](#authentication-modes) +- [Concurrency Model](#concurrency-model) +- [Tool Call Adaptation](#tool-call-adaptation) +- [Local Dev Packet Capture](#local-dev-packet-capture) +- [Documentation Index](#documentation-index) +- [Testing](#testing) +- [Release Artifact Automation (GitHub Actions)](#release-artifact-automation-github-actions) +- [Disclaimer](#disclaimer) + ## Architecture Overview (Summary) ```mermaid