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
@@ -3006,7 +3006,7 @@ export const ar: TranslationKeys = {
analytics: {
heading: "تحليلات المنتج",
description: "مشاركة بيانات الاستخدام المجهولة للمساعدة في تحسين SnapOtter.",
privacyNote: "صورك لا تغادر جهازك أبدًا.",
privacyNote: "ملفاتك لا تغادر شبكتك أبدًا.",
disabledByAdmin: "تم تعطيل تحليلات المنتج بواسطة مسؤول الخادم.",
enabledLabel: "التحليلات مفعّلة",
disabledLabel: "التحليلات معطّلة",
@@ -3014,7 +3014,7 @@ export const ar: TranslationKeys = {
},
aiFeatures: {
title: "AI Features",
description: "Manage AI model bundles for advanced image processing.",
description: "إدارة حزم نماذج AI لمعالجة الملفات المتقدمة.",
installAll: "Install All",
diskUsage: "Disk usage:",
installed: "Installed",
@@ -3035,7 +3035,7 @@ export const ar: TranslationKeys = {
heading: "حول",
appName: "SnapOtter",
appDescription:
"مجموعة أدوات معالجة صور ذاتية الاستضافة تركز على الخصوصية مع 70+ أداة. تغيير الحجم والضغط والتحويل والعلامات المائية وأتمتة سير عمل الصور دون إرسال البيانات إلى السحابة.",
"مجموعة أدوات معالجة ملفات ذاتية الاستضافة تركز على الخصوصية مع 157 أداة. تحويل وضغط وتحرير ونسخ صوتي وتعرّف ضوئي وأتمتة سير عمل الصور والفيديو والصوت والمستندات والبيانات دون إرسال البيانات إلى السحابة.",
versionLabel: "الإصدار:",
linksHeading: "روابط",
githubLink: "مستودع GitHub",
@@ -3083,8 +3083,8 @@ export const ar: TranslationKeys = {
passwordManagedByProvider: "يتم إدارة تغيير كلمة المرور بواسطة مزود الهوية الخاص بك.",
enterUsername: "أدخل اسم المستخدم",
enterPassword: "أدخل كلمة المرور",
heroTitle: "صورك. تبقى ملكك.",
heroSubtitle: "كل أدوات الصور التي تحتاجها.",
heroTitle: "ملفاتك. تبقى ملكك.",
heroSubtitle: "كل أداة تحتاجها.",
rotatingPhrases: [
"بدون تسجيل. بدون حسابات.",
"لا شيء يُرفع للسحابة. أبدًا.",
@@ -3093,7 +3093,7 @@ export const ar: TranslationKeys = {
"بلا حدود. بلا قيود خفية.",
"يعمل بدون إنترنت.",
"معالجة جماعية بلا حدود.",
"70+ أداة للصور.",
"157 أداة.",
"15 نموذج AI. على جهازك.",
"سريع كالبرق. مبني على Sharp.",
"يعمل في بيئات معزولة.",
@@ -3105,7 +3105,7 @@ export const ar: TranslationKeys = {
"البديل ذاتي الاستضافة.",
"تغيير الحجم والضغط والتحويل. محليًا.",
"محرر صور مجاني. بدون علامات مائية.",
"معالجة صور جماعية. بلا حدود.",
"معالجة ملفات جماعية. بلا حدود.",
"إزالة الخلفية بدون إنترنت.",
"بديل Canva ذاتي الاستضافة.",
"بدون مفاتيح API.",
@@ -3294,12 +3294,12 @@ export const ar: TranslationKeys = {
"التشويق جزء من التجربة...",
"نعلّم جهازك حيلًا جديدة...",
"نجهّز قدراتك الخارقة...",
"صورك ستشكرك لاحقًا...",
"ملفاتك ستشكرك لاحقًا...",
"جاري التحميل... بأناقة...",
"وقت مناسب لفنجان قهوة...",
"روما لم تُبنَ في يوم واحد...",
"صمتًا... عبقري يعمل...",
"نحضّر مفاجأة لصورك...",
"مشاريعك ستغار مما هو قادم...",
"نجمّع فريق الأحلام...",
"نفتح صندوق الإبداع...",
"كدنا ننتهي من التفكير في البدء... نمزح فقط...",
@@ -3318,7 +3318,7 @@ export const ar: TranslationKeys = {
gettingStarted: {
heading: "البدء",
description:
"اختر أداة من الشريط الجانبي أو ابحث عن واحدة. ارفع صورة بسحبها إلى الصفحة أو بالضغط على منطقة الرفع. اضبط الإعدادات وحمّل نتيجتك.",
"اختر أداة من الشريط الجانبي أو ابحث عن واحدة. ارفع ملفًا بسحبه إلى الصفحة أو بالضغط على منطقة الرفع. اضبط الإعدادات وحمّل نتيجتك.",
},
keyboardShortcuts: {
heading: "اختصارات لوحة المفاتيح",
@@ -3359,13 +3359,13 @@ export const ar: TranslationKeys = {
analytics: {
consentTitle: "ساعد في تحسين SnapOtter",
consentDescription:
"إحصائيات الاستخدام المجهولة تساعدنا في إصلاح الأخطاء وبناء الأدوات التي تحتاجها فعلًا. صورك وملفاتك تبقى على جهازك.",
"إحصائيات الاستخدام المجهولة تساعدنا في إصلاح الأخطاء وبناء الأدوات التي تحتاجها فعلًا. ملفاتك تبقى على شبكتك.",
consentChangeable: "يمكنك إيقاف هذا في أي وقت من الإعدادات.",
acceptButton: "بالتأكيد، موافق",
declineButton: "ليس الآن",
settingsTitle: "تحليلات المنتج",
settingsDescription: "مشاركة بيانات الاستخدام المجهولة للمساعدة في تحسين SnapOtter.",
settingsPrivacy: "صورك لا تغادر جهازك أبدًا.",
settingsPrivacy: "ملفاتك لا تغادر شبكتك أبدًا.",
settingsDisabledByAdmin: "تم تعطيل تحليلات المنتج بواسطة مسؤول الخادم.",
learnMore: "معرفة المزيد",
},