Skip to content

docs: 重构 README 排版 - #18

Merged
DNTOF merged 4 commits into
mainfrom
cursor/readme-redesign-d2dd
Nov 13, 2026
Merged

DNTOF merged 4 commits into
mainfrom
cursor/readme-redesign-d2dd

Conversation

@DNTOF

@DNTOF DNTOF commented Nov 13, 2026 •

Copy link
Copy Markdown
Owner

重写 README.md 的结构与呈现方式,原有的技术信息(依赖、配置、鉴权、TLS、接口、测试、许可证)全部保留。

  • 顶部居中标题、一句话定位、徽章(Release / 下载量 / 测试状态 / 许可证 / SCP:SL 14.2.8 / LabAPI / .NET 4.8)和快捷导航
  • 重绘架构总览 SVG(docs/assets/sldataapi-overview-{light,dark}.svg),由 docs/assets/generate-overview.py 生成,深浅主题自动切换
  • 数据条:40+ 控制端点、19 种事件、48 kHz 语音、单端口承载 HTTP / WS / TLS、180+ 回归用例(均按源码统计)
  • 「为什么选择」六宫格亮点卡片;功能表新增自动更新一行
  • 快速开始拆成 准备依赖 → 安装 → 初始化 → 第一个请求 四步,并附 curl 示例
  • 长配置块、请求示例、CI 说明改为可折叠;TLS 模式改为对照表;测试套件补充覆盖范围表
  • 「生态」新增官方客户端 SLConsole 与 Foundation Console 介绍卡片,以及 AstrBot 插件、适配插件示例与赞助链接;使用 GitHub 提示框突出升级与测试注意事项

已通过 GitHub Markdown 渲染接口确认折叠块、提示框与标题正常渲染。

架构图预览

浅色

深色

To show artifacts inline, enable in settings.

Open in Web Open in Cursor 

cursoragent and others added 4 commits November 13, 2026 08:00
Co-authored-by: DNT_OF <allowcache@gmail.com>
Co-authored-by: DNT_OF <allowcache@gmail.com>
Co-authored-by: DNT_OF <allowcache@gmail.com>
Co-authored-by: DNT_OF <allowcache@gmail.com>
@DNTOF
DNTOF merged commit 74f1b3a into main Nov 13, 2026
8 checks passed
@DNTOF
DNTOF deleted the cursor/readme-redesign-d2dd branch November 13, 2026 08:12
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.

2 participants