mirror of
https://github.com/cita-777/metapi.git
synced 2026-11-01 03:53:43 +08:00
ImgBotApp
cb1d76c822
*Total -- 16,844.96kb -> 11,144.54kb (33.84%) /src/web/public/desktop-tray-template.png -- 2.35kb -> 1.05kb (55.37%) /docs/screenshots/donehub-token.png -- 215.08kb -> 116.01kb (46.06%) /docs/public/logos/drafts/logo1.png -- 5,242.26kb -> 3,141.12kb (40.08%) /docs/public/logos/logo.png -- 123.83kb -> 77.82kb (37.15%) /docs/public/logos/logo-icon-128.png -- 34.64kb -> 21.89kb (36.81%) /docs/screenshots/checkin.png -- 696.32kb -> 445.91kb (35.96%) /docs/public/logos/logo-icon-512.png -- 477.52kb -> 308.22kb (35.45%) /src/web/public/desktop-icon.png -- 351.89kb -> 227.88kb (35.24%) /build/desktop-icon.png -- 351.89kb -> 227.88kb (35.24%) /docs/screenshots/tokens.png -- 503.91kb -> 332.00kb (34.11%) /docs/screenshots/settings.png -- 300.99kb -> 198.73kb (33.98%) /docs/screenshots/proxy-logs.png -- 485.85kb -> 321.57kb (33.81%) /docs/public/logos/drafts/logo2.png -- 1,789.13kb -> 1,186.45kb (33.69%) /docs/screenshots/proxy-logs-mapping.png -- 409.67kb -> 272.13kb (33.57%) /docs/screenshots/sites.png -- 634.05kb -> 425.44kb (32.9%) /docs/screenshots/notification-settings.png -- 323.97kb -> 217.43kb (32.89%) /docs/public/logos/drafts/logo3.png -- 1,230.31kb -> 844.78kb (31.34%) /docs/public/logos/logo-icon-64.png -- 9.81kb -> 6.77kb (30.99%) /docs/screenshots/monitor.png -- 497.85kb -> 343.84kb (30.94%) /docs/screenshots/sub2api-auth-f12.png -- 92.58kb -> 64.01kb (30.85%) /docs/screenshots/route-group.png -- 213.05kb -> 149.47kb (29.85%) /docs/public/logos/logo-banner.png -- 94.92kb -> 67.79kb (28.58%) /docs/screenshots/playground.png -- 599.01kb -> 429.90kb (28.23%) /docs/public/logos/logo-banner-sm.png -- 31.83kb -> 23.79kb (25.26%) /docs/public/logos/logo-full.png -- 121.20kb -> 90.99kb (24.92%) /docs/screenshots/sub2api-session-config.png -- 169.61kb -> 127.66kb (24.74%) /docs/screenshots/session-cookie-f12.png -- 84.87kb -> 64.99kb (23.43%) /docs/screenshots/routes-filter.png -- 429.24kb -> 332.14kb (22.62%) /docs/public/logos/logo-full-sm.png -- 40.96kb -> 32.34kb (21.06%) /docs/sponsors/ipwo.png -- 725.46kb -> 580.84kb (19.93%) /docs/screenshots/api-key-management.png -- 122.64kb -> 99.77kb (18.65%) /docs/public/logos/logo-icon-32.png -- 2.84kb -> 2.32kb (18.11%) /docs/screenshots/metapi-architecture.png -- 435.42kb -> 361.62kb (16.95%) Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
文档维护与贡献
/README路由为兼容旧链接与维护工作流而保留。面向所有用户的公开入口始终是 文档首页。
这页适合谁
- 文档维护者：调整导航、重构内容结构、检查首页是否仍然聚焦对外说明。
- FAQ / 教程贡献者：补充排障经验、接入说明、案例沉淀。
- 功能发布或运维负责人：在能力变更后同步校正文档入口、截图和索引。
文档站运行
本地预览：
npm run docs:dev
构建静态站点：
npm run docs:build
内容地图
| 内容领域 | 首选页面 | 什么时候改这里 |
|---|---|---|
| 对外第一印象、产品定位、核心入口 | 文档首页 | 需要调整公开落地页信息架构、首页 CTA 或首屏导航时 |
| 新用户部署与首条请求 | 快速上手 | 新安装流程、默认端口、首次调用步骤变化时 |
| 上游平台选择与接法 | 上游接入 | 平台支持范围、官方预设、API 请求地址池、自动识别规则变化时 |
| Provider OAuth 授权 | OAuth 管理 | 支持的 OAuth provider、授权流程、回调方式或自动重绑能力变化时 |
| 生产部署与回滚 | 部署指南 | Docker Compose、反向代理、升级回滚策略变更时 |
| K3s / Helm 高级升级面板 | K3s 更新中心（高级） | 需要说明谁适合使用更新中心、helper 怎么配、K3s/Helm 发布链路怎么接入时 |
| 环境变量、参数和配置项 | 配置说明 | 设置页 / 通知设置 / 下游密钥这些 UI 入口变化，或仅剩 env-only 的部署级参数变化时 |
| 客户端与工具接入 | 客户端接入 | Open WebUI、Cherry Studio、Cursor 等接入方式变化时 |
| 管理后台脚本化调用 | 管理 API | 需要说明如何用脚本批量导入站点/账号，或对接外部自动化时 |
| 运维排障与日常维护 | 运维手册 / 常见问题 | 新排障案例、备份恢复、健康检查、典型报错变化时 |
| FAQ / 教程协作沉淀 | FAQ/教程贡献规范 | 需要新增教程、FAQ 模板、内容提交流程时 |
| 仓库目录与组织约定 | 目录规范 | 目录结构、归档策略或命名约定变化时 |
| 工程守则与漂移治理 | Harness Engineering | 需要更新仓库级黄金原则、自动巡检范围或垃圾回收流程时 |
维护约定
- 文档首页 是唯一公共落地页。不要在
/README或其他主题页重新堆一份文档中心总览。 - 优先补强现有页面，再决定是否新增页面。只有在读者对象、内容边界和长期维护者都明确时再扩展路由。
- 导航、侧边栏和页面标题应反映公开入口和维护入口的分工，避免两个首页争夺注意力。
- 内链优先使用站内 clean URL 形式，保证 VitePress 构建结果和部署路径一致。
- 涉及界面、架构或流程变化时，同步检查首页截图、架构图和相关说明是否仍然匹配当前产品。
更新前自检
- 先确认目标读者是谁，以及内容该落在哪个现有页面。
- 如果入口结构变了，同步更新
docs/.vitepress/config.ts的nav和sidebar。 - 检查新增或修改的内链是否还能在站内自然发现，不要把关键入口只藏在单个页面里。
- 运行
npm run docs:build，确认没有引入构建错误，并额外抽查关键入口与内链。