docs: multi-modality rebrand, 2.0 architecture accuracy, and full OpenAPI coverage (#254)

* docs: rebrand from image-only to multi-modality across docs and metadata

SnapOtter expanded from image-only to 157 tools across 5 modalities
(image, video, audio, document/PDF, data). Update all product-level
copy, metadata, and i18n that still framed it as an image-only tool.

- README, package.json, root llms.txt: multi-modality framing, 157 tools
- OpenAPI info + tags, generated /llms.txt tagline (docs.ts)
- VitePress docs site: hero, getting-started, architecture, security,
  deployment, configuration, developer, supported-formats
- i18n: 10 product keys across all 21 locales (hero, app description,
  privacy notes, AI features, progress messages, getting-started)
- web/demo/landing meta + privacy copy, COMMUNITY_GUIDE, .env.example

Stale tool counts (53/50+/52/70+/35) corrected to 157 throughout.
Database/container deployment claims left unchanged (out of scope).

* docs: fix stale post-rebrand test assertions and README language list

- tests/e2e-docs/homepage.spec.ts: assert the current docs homepage (file toolkit, 157 tools, 5 modalities) instead of the old image-only strings
- tests/unit/api/docs-route.test.ts: sync the reproduced llms.txt tagline with docs.ts
- README.md: 21 languages with the correct list (add Swedish and Chinese Traditional, drop Czech which is not supported)

* docs: correct 2.0 architecture references (Postgres 17 + Redis 8, 3-container stack)

The docs and metadata still described the 1.x stack (SQLite, single container, p-queue). Update them to the current 2.0 reality.

- README: replace the broken single-container `docker run` quick-start with the real Docker Compose stack (app + Postgres 17 + Redis 8); fix the "no Redis, no Postgres" feature bullet
- package.json: description no longer claims a single container
- apps/docs: rewrite database.md for Postgres; configuration.md DB_PATH -> DATABASE_URL + REDIS_URL; architecture.md SQLite/p-queue/better-sqlite3 -> Postgres/BullMQ/pg and add media-engine + doc-engine; developer/security/deployment/docker-tags/getting-started/contributing compose examples now include postgres + redis; index.md + api/ai.md AI count 16 -> 19
- SECURITY.md: Drizzle (SQLite) -> (PostgreSQL)
- landing: enterprise/FeatureHighlights single-container wording; TrustSignals/ToolGrid 150+ -> 157 (dynamic); Pricing/FAQ 15 -> 19 AI tools

* docs(api): document all video, audio, document, and data tool endpoints in OpenAPI

The spec covered only image tools; the Scalar UI and the generated /llms.txt and /llms-full.txt inherited that gap. Add the 104 missing tool endpoints so the API docs match the code.

- Video: 29 endpoints (most long/async; auto-subtitles is AI)
- Audio: 17 (transcribe-audio is AI)
- Document/PDF: 36 (ocr-pdf is AI; conversions are long/async)
- Data: 10
- Image: 12 newer tools (background-replace, blur-background AI; histogram/lqip-placeholder/sprite-sheet custom responses; barcode-generate uses a JSON body)

Each schema is derived from the tool's Zod validator and executionHint (fast -> 200, long -> 202+SSE, AI adds 501 FeatureNotInstalledError, multi-file inputs as arrays), referencing the existing shared schemas. Tool path entries: 64 -> 168. Spec parses as valid YAML with no duplicate paths and only known $refs.
This commit is contained in:
SnapOtter
2026-06-16 18:04:52 +08:00
committed by GitHub
parent 8eee17aeea
commit 17726ae59d
59 changed files with 6135 additions and 468 deletions
+12 -12
View File
@@ -2946,7 +2946,7 @@ export const zhCN: TranslationKeys = {
analytics: {
heading: "产品分析",
description: "分享匿名使用数据,帮助改进 SnapOtter。",
privacyNote: "您的图片永远不会离开您的机器。",
privacyNote: "您的文件永远不会离开您的网络。",
disabledByAdmin: "产品分析已被服务器管理员禁用。",
enabledLabel: "分析已启用",
disabledLabel: "分析已禁用",
@@ -2954,7 +2954,7 @@ export const zhCN: TranslationKeys = {
},
aiFeatures: {
title: "AI Features",
description: "Manage AI model bundles for advanced image processing.",
description: "管理用于高级文件处理的 AI 模型包。",
installAll: "Install All",
diskUsage: "Disk usage:",
installed: "Installed",
@@ -2975,7 +2975,7 @@ export const zhCN: TranslationKeys = {
heading: "关于",
appName: "SnapOtter",
appDescription:
"自托管、隐私优先的图片处理套件,包含 70+ 种工具。调整大小、压缩、转换、加水印,自动化您的图片工作流,无需将数据发送到云端。",
"自托管、隐私优先的文件处理套件,包含 157 种工具。转换、压缩、编辑、转录、OCR,自动化图片、视频、音频、文档和数据工作流,无需将数据发送到云端。",
versionLabel: "版本:",
linksHeading: "链接",
githubLink: "GitHub 仓库",
@@ -3023,8 +3023,8 @@ export const zhCN: TranslationKeys = {
passwordManagedByProvider: "密码修改由您的身份提供商管理。",
enterUsername: "输入用户名",
enterPassword: "输入密码",
heroTitle: "您的图片,由您掌控。",
heroSubtitle: "您需要的每一种图片工具。",
heroTitle: "您的文件,由您掌控。",
heroSubtitle: "您需要的每一种工具。",
rotatingPhrases: [
"无需注册,无需账号。",
"永不上传到云端。",
@@ -3033,7 +3033,7 @@ export const zhCN: TranslationKeys = {
"无限制,无隐藏上限。",
"完全离线可用。",
"无限批量处理。",
"70+ 种图片工具。",
"157 种工具。",
"15 个 AI 模型,在你自己的设备上运行。",
"基于 Sharp 构建,闪电般快速。",
"支持内网隔离部署。",
@@ -3045,7 +3045,7 @@ export const zhCN: TranslationKeys = {
"自托管的替代方案。",
"调整大小、压缩、转换,全部在本地完成。",
"免费图片编辑器,无水印。",
"批量图片处理,无限制。",
"批量文件处理,无限制。",
"离线移除背景。",
"自托管的 Canva 替代品。",
"无需 API 密钥。",
@@ -3233,12 +3233,12 @@ export const zhCN: TranslationKeys = {
"悬念也是体验的一部分...",
"正在教你的电脑学新本事...",
"正在为你配置超能力...",
"你的图片以后会感谢你的...",
"你的文件以后会感谢你的...",
"加载中... 但要加点仪式感...",
"现在正适合去泡杯咖啡...",
"罗马也不是一天建成的...",
"嘘... 天才正在工作...",
"让你的照片提前嫉妒一下...",
"让你的项目提前嫉妒一下...",
"正在集结梦之队...",
"正在拆箱精彩内容...",
"差不多要开始想要不要开始了... 开玩笑的...",
@@ -3256,7 +3256,7 @@ export const zhCN: TranslationKeys = {
heading: "帮助",
gettingStarted: {
heading: "快速入门",
description: "从侧边栏选择工具或搜索。将图片拖到页面上或点击上传区域。调整设置后下载结果。",
description: "从侧边栏选择工具或搜索。将文件拖到页面上或点击上传区域。调整设置后下载结果。",
},
keyboardShortcuts: {
heading: "键盘快捷键",
@@ -3297,13 +3297,13 @@ export const zhCN: TranslationKeys = {
analytics: {
consentTitle: "帮助改进 SnapOtter",
consentDescription:
"匿名使用统计帮助我们修复问题并构建您真正需要的工具。您的图片和文件始终留在您的设备上。",
"匿名使用统计帮助我们修复问题并构建您真正需要的工具。您的文件始终留在您的网络中。",
consentChangeable: "您可以随时在设置中关闭。",
acceptButton: "好的,没问题",
declineButton: "暂时不了",
settingsTitle: "产品分析",
settingsDescription: "分享匿名使用数据,帮助改进 SnapOtter。",
settingsPrivacy: "您的图片永远不会离开您的机器。",
settingsPrivacy: "您的文件永远不会离开您的网络。",
settingsDisabledByAdmin: "产品分析已被服务器管理员禁用。",
learnMore: "了解更多",
},