From 5c070a5857a5eecd020edaec2eebdf51515cbe4c Mon Sep 17 00:00:00 2001 From: Abdelrahman Essawy Date: Tue, 2 Jun 2026 15:11:55 +0300 Subject: [PATCH 1/2] docs: rename raw.ffmpeg job type to ffmpeg with redirects --- changelog/2026-03-20.mdx | 8 +++---- cli/ci-cd.mdx | 4 ++-- cli/commands.mdx | 2 +- cli/overview.mdx | 8 +++---- concepts/credits.mdx | 6 ++--- concepts/job-lifecycle.mdx | 2 +- docs.json | 12 ++++++++-- guides/{raw-ffmpeg.mdx => ffmpeg.mdx} | 28 ++++++++++++------------ guides/webhooks.mdx | 4 ++-- job-types/captions-animate.mdx | 2 +- job-types/{raw-ffmpeg.mdx => ffmpeg.mdx} | 20 ++++++++--------- mcp/examples.mdx | 6 ++--- mcp/tools.mdx | 12 +++++----- quickstart.mdx | 18 +++++++-------- support/errors.mdx | 4 ++-- support/faq.mdx | 8 +++---- support/limits.mdx | 8 +++---- 17 files changed, 80 insertions(+), 72 deletions(-) rename guides/{raw-ffmpeg.mdx => ffmpeg.mdx} (91%) rename job-types/{raw-ffmpeg.mdx => ffmpeg.mdx} (87%) diff --git a/changelog/2026-03-20.mdx b/changelog/2026-03-20.mdx index e25017b..dbcc90a 100644 --- a/changelog/2026-03-20.mdx +++ b/changelog/2026-03-20.mdx @@ -1,6 +1,6 @@ --- title: "Documentation site launch, 2026-03-20" -description: "View the initial docs launch with the raw.ffmpeg reference, webhook guide, and MCP integration docs. Powered by Mintlify with AI-optimized content." +description: "View the initial docs launch with the FFmpeg reference, webhook guide, and MCP integration docs. Powered by Mintlify with AI-optimized content." icon: "sparkles" keywords: ["rendobar changelog", "rendobar releases", "docs launch", "rendobar 2026"] --- @@ -13,7 +13,7 @@ keywords: ["rendobar changelog", "rendobar releases", "docs launch", "rendobar 2 "@type": "TechArticle", "@id": "https://rendobar.com/docs/changelog/2026-03-20/#article", "headline": "Documentation site launch, 2026-03-20", - "description": "Initial docs launch: raw.ffmpeg reference, webhook guide, and MCP integration docs.", + "description": "Initial docs launch: FFmpeg reference, webhook guide, and MCP integration docs.", "datePublished": "2026-03-20", "dateModified": "2026-05-24", "author": { "@type": "Organization", "@id": "https://rendobar.com/#organization" }, @@ -24,13 +24,13 @@ keywords: ["rendobar changelog", "rendobar releases", "docs launch", "rendobar 2 /> -Rendobar documentation is now live at [rendobar.com/docs](https://rendobar.com/docs). Includes the [`raw.ffmpeg` reference](/job-types/raw-ffmpeg), a [webhooks guide](/guides/webhooks), and [MCP integration docs](/mcp/overview) for AI agents. The site is powered by Mintlify with an interactive API playground and AI-optimized content. +Rendobar documentation is now live at [rendobar.com/docs](https://rendobar.com/docs). Includes the [`ffmpeg` reference](/job-types/ffmpeg), a [webhooks guide](/guides/webhooks), and [MCP integration docs](/mcp/overview) for AI agents. The site is powered by Mintlify with an interactive API playground and AI-optimized content. ## Related - [Quickstart](/quickstart): submit your first job in under five minutes -- [raw.ffmpeg reference](/job-types/raw-ffmpeg): the live job type and its parameters +- [FFmpeg reference](/job-types/ffmpeg): the live job type and its parameters - [MCP overview](/mcp/overview): connect any MCP-compatible agent to Rendobar - [Full release history](https://rendobar.com/changelog/): every shipped update on the marketing site - [Pricing](https://rendobar.com/pricing/): Free vs Pro and credit packs diff --git a/cli/ci-cd.mdx b/cli/ci-cd.mdx index 5c5e945..20922d5 100644 --- a/cli/ci-cd.mdx +++ b/cli/ci-cd.mdx @@ -159,7 +159,7 @@ sudo mv rb /usr/local/bin/rb ## Idempotency -The CLI does not expose `--idempotency-key`. If a retried CI step shouldn't double-charge, submit via the [SDK](https://www.npmjs.com/package/@rendobar/sdk) or [`POST /jobs`](/job-types/raw-ffmpeg) directly with an `idempotencyKey` field. +The CLI does not expose `--idempotency-key`. If a retried CI step shouldn't double-charge, submit via the [SDK](https://www.npmjs.com/package/@rendobar/sdk) or [`POST /jobs`](/job-types/ffmpeg) directly with an `idempotencyKey` field. ## See also @@ -173,5 +173,5 @@ The CLI does not expose `--idempotency-key`. If a retried CI step shouldn't doub - [CLI overview](/cli/overview): pick between CLI, SDK, and raw HTTP - [Authentication](/cli/authentication): `RENDOBAR_API_KEY` as the only CI-safe auth path - [Commands reference](/cli/commands): exit codes for boolean assertions -- [raw.ffmpeg reference](/job-types/raw-ffmpeg): the API the CLI invokes per run +- [FFmpeg reference](/job-types/ffmpeg): the API the CLI invokes per run - [Changelog](https://rendobar.com/changelog/): pin a release tag with confidence diff --git a/cli/commands.mdx b/cli/commands.mdx index 7b487cd..3b982a7 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -188,5 +188,5 @@ Exits `2` if not authenticated, `1` if the API call fails. - [CLI overview](/cli/overview): narrative quickstart for `rb ffmpeg` - [Authentication](/cli/authentication): `rb login` flow and credential storage - [CI/CD](/cli/ci-cd): parse `--json` output and authenticate from a secret -- [raw.ffmpeg reference](/job-types/raw-ffmpeg): the underlying API call +- [FFmpeg reference](/job-types/ffmpeg): the underlying API call - [Changelog](https://rendobar.com/changelog/): release notes for every `rb` version diff --git a/cli/overview.mdx b/cli/overview.mdx index a7e21e2..107d541 100644 --- a/cli/overview.mdx +++ b/cli/overview.mdx @@ -36,7 +36,7 @@ rb login rb ffmpeg -i input.mp4 -vf scale=1280:720 -c:v libx264 -crf 23 output.mp4 ``` -The binary is called `rb`. It auto-uploads local inputs, submits a [`raw.ffmpeg`](/job-types/raw-ffmpeg) job, and downloads the result to the path your `ffmpeg` command names. +The binary is called `rb`. It auto-uploads local inputs, submits an [`ffmpeg`](/job-types/ffmpeg) job, and downloads the result to the path your `ffmpeg` command names. ## CLI or SDK @@ -45,7 +45,7 @@ The binary is called `rb`. It auto-uploads local inputs, submits a [`raw.ffmpeg` | A shell or CI script | CLI | | A Node.js / TypeScript program | [SDK](https://www.npmjs.com/package/@rendobar/sdk) | -The CLI covers `raw.ffmpeg` and the auth + diagnostics around it. The SDK covers every endpoint with typed responses, webhooks, and batch orchestration. +The CLI covers `ffmpeg` and the auth + diagnostics around it. The SDK covers every endpoint with typed responses, webhooks, and batch orchestration. ## Install @@ -82,7 +82,7 @@ rb ffmpeg -i ./clip.mp4 -vf scale=1280:720 -c:v libx264 -crf 23 out.mp4 ## Scope -The CLI does one thing: run FFmpeg jobs. It does not bundle filter chaining, batch primitives, or the other [job types](/job-types/raw-ffmpeg). Submit those via the [SDK](https://www.npmjs.com/package/@rendobar/sdk) or [`POST /jobs`](/job-types/raw-ffmpeg). +The CLI does one thing: run FFmpeg jobs. It does not bundle filter chaining, batch primitives, or the other [job types](/job-types/ffmpeg). Submit those via the [SDK](https://www.npmjs.com/package/@rendobar/sdk) or [`POST /jobs`](/job-types/ffmpeg). ## See also @@ -97,5 +97,5 @@ The CLI does one thing: run FFmpeg jobs. It does not bundle filter chaining, bat - [Installation](/cli/installation): one-line install, pin a version, Docker, uninstall - [Commands reference](/cli/commands): every `rb` subcommand, flag, and exit code - [CI/CD](/cli/ci-cd): GitHub Actions, GitLab CI, and Docker recipes -- [raw.ffmpeg reference](/job-types/raw-ffmpeg): the API the CLI calls under the hood +- [FFmpeg reference](/job-types/ffmpeg): the API the CLI calls under the hood - [FFmpeg in the cloud](https://rendobar.com/ffmpeg/): supported operations on the marketing site diff --git a/concepts/credits.mdx b/concepts/credits.mdx index dd7647d..91b327a 100644 --- a/concepts/credits.mdx +++ b/concepts/credits.mdx @@ -41,7 +41,7 @@ Per-job billing from a prepaid credit balance. New accounts get $5 free. Every t | Output retention | 7 days | 30 days | | Priority queue | No | Yes | -`raw.ffmpeg`, MCP, and webhooks are on both plans. Full limits table: [Limits](/support/limits). +`ffmpeg`, MCP, and webhooks are on both plans. Full limits table: [Limits](/support/limits). For a full pricing breakdown and plan comparison, see [rendobar.com/pricing/](https://rendobar.com/pricing/). @@ -69,7 +69,7 @@ Because the submit gate checks `balance > 0` rather than an estimate, a single l ## Cost model -`raw.ffmpeg` bills per compute second, which is the wall-clock time FFmpeg ran your command, excluding upload and download. Typical cost: ~$0.05/min. The same per-second rate applies whether the job completes successfully or fails partway through. +`ffmpeg` bills per compute second, which is the wall-clock time FFmpeg ran your command, excluding upload and download. Typical cost: ~$0.05/min. The same per-second rate applies whether the job completes successfully or fails partway through. If your balance is at or below zero when you submit: @@ -117,7 +117,7 @@ Returns daily usage by job type: count, amount charged, and compute seconds. - [Job lifecycle](/concepts/job-lifecycle): where the debit happens - [Limits](/support/limits): full quota table -- [raw.ffmpeg reference](/job-types/raw-ffmpeg): the live cost model +- [FFmpeg reference](/job-types/ffmpeg): the live cost model ## Related diff --git a/concepts/job-lifecycle.mdx b/concepts/job-lifecycle.mdx index eecea8d..f89f750 100644 --- a/concepts/job-lifecycle.mdx +++ b/concepts/job-lifecycle.mdx @@ -96,5 +96,5 @@ Two ways to stop polling: - [Webhooks](/guides/webhooks): push status changes to your server instead of polling - [Credits and billing](/concepts/credits): when and how the terminal debit lands - [Error codes](/support/errors): every `error.code` returned by failed jobs -- [Raw FFmpeg](/guides/raw-ffmpeg): what runs between `dispatched` and `complete` +- [FFmpeg](/guides/ffmpeg): what runs between `dispatched` and `complete` - [Changelog](https://rendobar.com/changelog/): platform changes that affect job behavior diff --git a/docs.json b/docs.json index 1603d41..72867da 100644 --- a/docs.json +++ b/docs.json @@ -35,7 +35,7 @@ { "group": "Guides", "pages": [ - "guides/raw-ffmpeg", + "guides/ffmpeg", "guides/webhooks" ] }, @@ -59,7 +59,7 @@ { "group": "Reference", "pages": [ - "job-types/raw-ffmpeg", + "job-types/ffmpeg", "job-types/captions-animate", "job-types/caption-burn" ] @@ -120,6 +120,14 @@ { "source": "/guides/captions", "destination": "/job-types/captions-animate" + }, + { + "source": "/job-types/raw-ffmpeg", + "destination": "/job-types/ffmpeg" + }, + { + "source": "/guides/raw-ffmpeg", + "destination": "/guides/ffmpeg" } ], "navbar": { diff --git a/guides/raw-ffmpeg.mdx b/guides/ffmpeg.mdx similarity index 91% rename from guides/raw-ffmpeg.mdx rename to guides/ffmpeg.mdx index a131b51..8c5d467 100644 --- a/guides/raw-ffmpeg.mdx +++ b/guides/ffmpeg.mdx @@ -1,9 +1,9 @@ --- -title: "Raw FFmpeg guide" -sidebarTitle: "Raw FFmpeg" +title: "FFmpeg command guide" +sidebarTitle: "FFmpeg" description: "Run any FFmpeg command in the cloud. ~120 whitelisted flags, 8-layer sandboxed execution, signed download URL. Same FFmpeg syntax you know." icon: "terminal" -keywords: ["ffmpeg guide", "ffmpeg in cloud", "ffmpeg sandboxed execution", "ffmpeg flags whitelist", "raw ffmpeg api"] +keywords: ["ffmpeg guide", "ffmpeg in cloud", "ffmpeg sandboxed execution", "ffmpeg flags whitelist", "ffmpeg command api"] ---