mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
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:
@@ -19,12 +19,12 @@ const PROGRESS_MESSAGES = [
|
||||
"The suspense is part of the experience...",
|
||||
"Teaching your computer new tricks...",
|
||||
"Setting up your superpowers...",
|
||||
"Your images will thank you later...",
|
||||
"Your files will thank you later...",
|
||||
"Loading... but make it fancy...",
|
||||
"This would be a great time for coffee...",
|
||||
"Rome wasn't built in a day either...",
|
||||
"Shhh... genius at work...",
|
||||
"Making your photos jealous of what's coming...",
|
||||
"Making your projects jealous of what's coming...",
|
||||
"Assembling the dream team...",
|
||||
"Unpacking awesomeness...",
|
||||
"Almost done thinking about starting... just kidding...",
|
||||
|
||||
@@ -27,12 +27,12 @@ const PROGRESS_MESSAGES = [
|
||||
"The suspense is part of the experience...",
|
||||
"Teaching your computer new tricks...",
|
||||
"Setting up your superpowers...",
|
||||
"Your images will thank you later...",
|
||||
"Your files will thank you later...",
|
||||
"Loading... but make it fancy...",
|
||||
"This would be a great time for coffee...",
|
||||
"Rome wasn't built in a day either...",
|
||||
"Shhh... genius at work...",
|
||||
"Making your photos jealous of what's coming...",
|
||||
"Making your projects jealous of what's coming...",
|
||||
"Assembling the dream team...",
|
||||
"Unpacking awesomeness...",
|
||||
"Almost done thinking about starting... just kidding...",
|
||||
|
||||
@@ -22,7 +22,7 @@ export function PrivacyPolicyPage() {
|
||||
<section>
|
||||
<h2 className="text-lg font-semibold text-foreground mb-2">Overview</h2>
|
||||
<p>
|
||||
SnapOtter is a self-hosted, open-source image processing application. Your instance is
|
||||
SnapOtter is a self-hosted, open-source file processing application. Your instance is
|
||||
operated and controlled entirely by whoever deployed it. This policy describes how the
|
||||
software itself handles your data.
|
||||
</p>
|
||||
@@ -31,10 +31,10 @@ export function PrivacyPolicyPage() {
|
||||
<section>
|
||||
<h2 className="text-lg font-semibold text-foreground mb-2">Local Processing</h2>
|
||||
<p>
|
||||
All image processing happens entirely on the server where SnapOtter is deployed. Your
|
||||
images are never sent to external services or third-party APIs. When you upload an
|
||||
image for processing, it is handled in memory or in temporary storage on the host
|
||||
machine and is not retained after the operation completes.
|
||||
All file processing happens entirely on the server where SnapOtter is deployed. Your
|
||||
files are never sent to external services or third-party APIs. When you upload a file
|
||||
for processing, it is handled in memory or in temporary storage on the host machine
|
||||
and is not retained after the operation completes.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
@@ -101,10 +101,10 @@ export function PrivacyPolicyPage() {
|
||||
<section>
|
||||
<h2 className="text-lg font-semibold text-foreground mb-2">Third-Party Services</h2>
|
||||
<p>
|
||||
All image processing happens locally — your images are never sent anywhere. If you opt
|
||||
in to product analytics, anonymous usage data is sent to PostHog and Sentry as
|
||||
described above. AI-powered features run locally using bundled models. No other
|
||||
external services are contacted.
|
||||
All processing happens locally; your files are never sent anywhere. If you opt in to
|
||||
product analytics, anonymous usage data is sent to PostHog and Sentry as described
|
||||
above. AI-powered features run locally using bundled models. No other external
|
||||
services are contacted.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user