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:
@@ -12,7 +12,7 @@ Create these 5 categories in **Settings → Discussions → Categories** on GitH
|
||||
| Category | Format | Description |
|
||||
|----------|--------|-------------|
|
||||
| **General** | Open | Announcements, project updates, and casual conversation about SnapOtter. Pinned Welcome post lives here. |
|
||||
| **Q&A** | Question / Answer | Ask for help with image processing, tool behavior, or unexpected results. Mark accepted answers so others can find solutions quickly. |
|
||||
| **Q&A** | Question / Answer | Ask for help with file processing, tool behavior, or unexpected results. Mark accepted answers so others can find solutions quickly. |
|
||||
| **Ideas** | Open | Suggest new tools, improvements to existing features, or workflow changes. Upvote ideas you want to see prioritized. |
|
||||
| **Show & Tell** | Open | Share your SnapOtter setup — screenshots of pipelines, Docker Compose configs, automation scripts using the REST API, before/after results. |
|
||||
| **Self-Hosting Help** | Question / Answer | Docker, reverse proxy, storage, networking, multi-arch, and environment configuration. If your question is about getting SnapOtter running rather than using its tools, post here. |
|
||||
@@ -21,7 +21,7 @@ Create these 5 categories in **Settings → Discussions → Categories** on GitH
|
||||
|
||||
- **Q&A vs Self-Hosting Help** — Separating "how do I use the resize tool" from
|
||||
"how do I get SnapOtter behind Caddy" keeps both channels useful. Self-hosters
|
||||
and image-tool users are often different people with different expertise.
|
||||
and tool users are often different people with different expertise.
|
||||
- **Show & Tell** — Pipeline sharing/export isn't built into the app yet, so
|
||||
this category is the place to describe your workflows with screenshots and
|
||||
step lists. When export lands, this becomes the natural home for shared
|
||||
@@ -95,7 +95,7 @@ Two posts you can publish yourself to get early activity in the community.
|
||||
>
|
||||
> **Category:** Show & Tell
|
||||
>
|
||||
> Pipelines let you chain multiple image tools together and run them in one
|
||||
> Pipelines let you chain multiple tools together and run them in one
|
||||
> pass. I'd love to see what workflows people are building.
|
||||
>
|
||||
> Since there's no export button yet, just describe your steps or post a
|
||||
|
||||
Reference in New Issue
Block a user