# AUN SDK Python 文档查阅指南

AUN SDK 文档在 `python/docs/` 下，索引文件 `python/docs/INDEX.md` 分三层，**严格按需逐层加载，禁止一次性读取整个索引**。

行区间格式：`L43-49` 表示用 Read 工具读取时读取第 43 行到 49 行。

## SDK 文档定位

SDK 文档聚焦两大核心封装：**认证（`client.auth`）** 和 **E2EE（`client.e2ee`）**。

其他业务操作（消息、群组、存储等）通过 `client.call(method, params)` 调用 RPC 方法，参数和响应格式见 RPC 手册：`src/aun_core/docs/skill/rpc-manual/`。

## 渐进式查阅流程

### Step 1：只读 Layer 1（L10-24）

列出所有文档名和章节行区间。能直接定位目标 → 跳 Step 4。

### Step 2：按需读 Layer 2 对应小节

仅当 Step 1 不够时，按关键词读：

身份与认证 L29-35 · 连接与状态 L37-42 · E2EE L44-51 · RPC与事件 L53-58 · 配置与存储 L60-68 · 错误处理 L70-74

### Step 3：按需读 Layer 3 单篇摘要

仅当需要某篇详情但不确定读哪个章节时：

快速开始 L80-82 · 核心概念 L84-86 · 连接与认证 L88-90 · E2EE加密通信 L92-94 · API参考 L96-98 · 错误处理 L100-102 · 最佳实践 L104-106

大多数问题在摘要层就能解答。

### Step 4：读原文目标章节

根据前面获得的文档路径和行区间，精确读取对应章节。**只有需要完整分析时才读整篇原文。**

## 文档总览

| 编号 | 文档 | 定位 |
|------|------|------|
| 01 | [快速开始](01-快速开始.md) | 安装、配置、最小示例 |
| 02 | [WebSocket协议](02-WebSocket协议.md) | 握手流程、消息格式、裸 WebSocket 示例 |
| 03 | [核心概念](03-核心概念.md) | AID、状态机、认证、E2EE |
| 04 | [连接与认证](04-连接与认证.md) | 认证封装、call()、on()、连接 |
| 05 | [E2EE加密通信](05-E2EE加密通信.md) | E2EE封装、自定义存储 |
| 06 | [API手册](06-API手册.md) | AUNClient / AuthNamespace / E2EEManager |
| 07 | [错误处理](07-错误处理.md) | 错误类层级、错误码、重试 |
| 08 | [最佳实践](08-最佳实践.md) | 幂等、隔离、资源清理 |

## 常见查阅场景

| 场景 | 推荐路径 |
|------|----------|
| 首次使用 SDK | 01-快速开始 全文 |
| 裸 WebSocket 或其他语言实现 | 02-WebSocket协议 |
| 理解 AID / E2EE 原理 | 03-核心概念 对应章节 |
| 认证 + 连接 + call/on 用法 | 04-连接与认证 |
| 需要加密通信 | 05-E2EE加密通信 |
| 查某个方法的签名 | 06-API手册 |
| 遇到报错需排查 | 07-错误处理 |
| 部署前检查 | 08-最佳实践 |
| 查 RPC 方法参数 | `src/aun_core/docs/skill/rpc-manual/` |
