docs: lead the README with ffmpeg and link out for the rest - #89
Merged
Conversation
ffmpeg is the type most people want first and the one that shows the value fastest, so it now carries the hero example. The old example used compress.target, which is a better fit for a size-budget story than for "why would I want this at all". The example is the volume filter gated on a timestamp, volume=enable='lt(t,3)'. Nobody remembers that syntax, and remembering it is exactly the job being handed to the agent. Replaces the six-row job types table with a paragraph on ffmpeg plus links to the five purpose-built types and to rendobar.com/docs/jobs. The table was the third stale enumeration of job types in this repo, after FEATURED_JOB_TYPES in src and the earlier three-row version of the same table. A README that does not enumerate cannot go stale. The intro paragraph committed to "six job types", which had the same problem, so it now names the categories without a count. Notes that params.compute gpu needs the Pro plan, per the live schema. Omitting that is the kind of gap someone hits at the worst moment. Verified: 22 URLs resolve including every /docs/jobs/* target, no banned words, no em dashes, no hardcoded counts.
a-essawy
force-pushed
the
docs/readme-lead-with-ffmpeg
branch
from
July 26, 2026 10:31
78ac1d1 to
b465c88
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #87.
ffmpeg carries the hero example now
It is the type most people reach for first and the one that shows the value fastest. The previous example used
compress.target, which tells a good size-budget story but a weaker "why would I want this at all" story.The example is the volume filter gated on a timestamp:
Nobody remembers that syntax. Remembering it is exactly the job being handed to the agent, so it makes the argument better than a flag anyone could guess.
The job types table is gone
Replaced with a paragraph on
ffmpegplus links to the five purpose-built types and to rendobar.com/docs/jobs.That table was the third stale enumeration of job types in this repo:
FEATURED_JOB_TYPESinsrc— three types, deleted in feat: read the live job registry without an API key #85A README that does not enumerate cannot go stale.
list_job_typesreads the registry live and is the source of truth; the docs site is the reference. The README now points at both instead of competing with them.The intro paragraph had the same problem, committing to "six job types". It names the categories without a count now, which keeps the keyword surface for retrieval without the maintenance.
One correctness fix
params.compute: "gpu"requires the Pro plan, per the live schema description. My first draft omitted that. It is the kind of gap someone discovers at the worst possible moment.Verification
/docs/jobs/*target I linked