docs: improve feature discoverability#230
Conversation
📝 WalkthroughWalkthroughREADME features restructured into organized subsections (Reliability, Workflows, Concurrency, Scheduling, Observability, Extensibility) with examples and guide links. New capabilities overview page created and integrated into documentation navigation to surface existing taskito features and preempt discoverability gaps. ChangesFeature discoverability improvements
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/content/docs/capabilities.mdx (1)
27-27: 💤 Low valueMinor inconsistency in example app name.
Line 27 uses
myapp:queuewhile the one-liner examples below (line 90) and the README usetasks:queue. Consider usingtasks:queueconsistently for easier copy-paste.📝 Suggested change for consistency
-| No Flower-like dashboard | [`taskito dashboard --app myapp:queue`](/guides/dashboard) serves a built-in monitoring UI. | +| No Flower-like dashboard | [`taskito dashboard --app tasks:queue`](/guides/dashboard) serves a built-in monitoring UI. |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/docs/capabilities.mdx` at line 27, Update the example app name in the capabilities table to match the rest of the docs: replace the `myapp:queue` usage in the table row containing the `taskito dashboard --app ...` example with `tasks:queue` so it matches the one-liner examples and README (search for the string `taskito dashboard --app` or the `myapp:queue` literal to locate the spot).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/content/docs/capabilities.mdx`:
- Line 27: Update the example app name in the capabilities table to match the
rest of the docs: replace the `myapp:queue` usage in the table row containing
the `taskito dashboard --app ...` example with `tasks:queue` so it matches the
one-liner examples and README (search for the string `taskito dashboard --app`
or the `myapp:queue` literal to locate the spot).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 82ecd9a0-6b58-499b-bb67-bed153e7d8c1
📒 Files selected for processing (5)
README.mddocs/content/docs/capabilities.mdxdocs/content/docs/getting-started/installation.mdxdocs/content/docs/guides/index.mdxdocs/content/docs/meta.json
Closes #83.
Summary
Preempts the recurring "feature X is missing" audits by making taskito's existing capabilities impossible to miss. Docs-only — no code outside
README.mdanddocs/.Changes
README
## Featuresbullet list into anchored subsections — Reliability, Workflows, Concurrency, Scheduling, Observability, Extensibility — each with a one-line code sample and a link to its deep-dive guide.docs site
docs/capabilities.mdx— "Capabilities at a glance": an "if you think it's missing, it isn't" table mapping the common reviewer claims → reality (each linked to its guide), a capability card grid, and copy-paste one-liners.meta.json), so it's the first hit from the docs index.CLI — verified
taskito --helpalready names the user-visible features (worker,dashboard,info,pause,resume,scaler,autoscale,resources,reload); no change needed.Acceptance criteria
README.mdanddocs/.Every documented API was verified against the source (
chain/group/chordexports,@queue.task(max_retries/retry_backoff/retry_on/dont_retry_on/soft_timeout/priority/rate_limit/middleware),current_job.check_timeout(),--pool prefork).pnpm --dir docs types:check,lint, andbuild(static export incl. the new/capabilitiesroute) all pass.Summary by CodeRabbit
Documentation