Skip to content

docs: improve feature discoverability#230

Merged
pratyush618 merged 2 commits into
masterfrom
docs/feature-discoverability
Jun 1, 2026
Merged

docs: improve feature discoverability#230
pratyush618 merged 2 commits into
masterfrom
docs/feature-discoverability

Conversation

@pratyush618
Copy link
Copy Markdown
Collaborator

@pratyush618 pratyush618 commented Jun 1, 2026

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.md and docs/.

Changes

README

  • Split the flat ## Features bullet 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.
  • Extended the comparison table with Workflows (chain/group/chord) and CPU parallelism (prefork pool) rows (the "Built-in dashboard" row already existed).
  • Linked Capabilities at a glance from the Features intro.

docs site

  • New top-level page 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.
  • Made it the first entry in the docs nav (meta.json), so it's the first hit from the docs index.
  • Cross-linked it from the Installation page (callout, first screen) and the Guides index.

CLI — verified taskito --help already names the user-visible features (worker, dashboard, info, pause, resume, scaler, autoscale, resources, reload); no change needed.

Acceptance criteria

  • ✅ A reader of the README TOC + comparison table can answer: chain/group/chord? dashboard? retry backoff? CPU-parallel pool? — all now explicit.
  • ✅ Docs index links to "Capabilities at a glance" within the first screen (nav top + Installation callout + Guides intro).
  • ✅ Each feature subsection has a one-line code sample and a deep-dive link.
  • ✅ No code changes outside README.md and docs/.

Every documented API was verified against the source (chain/group/chord exports, @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, and build (static export incl. the new /capabilities route) all pass.

Summary by CodeRabbit

Documentation

  • Reorganized README features section into categorized subsections covering reliability, workflows, concurrency, scheduling, observability, and extensibility, each with descriptions and example snippets
  • Created new capabilities overview page providing feature highlights with Python and bash examples
  • Updated installation and documentation guides with links to the capabilities overview
  • Enhanced comparison table with additional capability details

@github-actions github-actions Bot added the docs label Jun 1, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 1, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

README 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.

Changes

Feature discoverability improvements

Layer / File(s) Summary
README feature subsections and comparison table
README.md
Features section replaced with subsections for each capability category paired with examples and links. Comparison table extended to include Workflows and CPU parallelism rows for clearer feature visibility.
Capabilities overview documentation page
docs/content/docs/capabilities.mdx
New page with capability categories as cards, misconceptions clarification table, and one-liner examples in Python and bash demonstrating retries, workflows, worker pool, and dashboard features.
Documentation navigation wiring
docs/content/docs/getting-started/installation.mdx, docs/content/docs/guides/index.mdx, docs/content/docs/meta.json
Installation guide adds callout directing to capabilities overview, guides index links to capabilities page, and navigation metadata registers the new page in the doc structure.

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 A rabbit hops through the docs with glee,
"Workflows! Dashboard! For all to see!"
No more missed features, no more doubt,
Each capability shines throughout.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: improve feature discoverability' directly reflects the main change in the PR, which restructures README and adds a capabilities overview page to improve feature visibility.
Linked Issues check ✅ Passed All objectives from issue #83 are met: README split into named subsections with anchors, top-level capabilities page created and integrated into docs nav, comparison table extended, and no code changes outside README and docs.
Out of Scope Changes check ✅ Passed All changes (README.md, new capabilities.mdx, installation.mdx, guides/index.mdx, meta.json) are directly aligned with improving feature discoverability as specified in issue #83; no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/feature-discoverability

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/content/docs/capabilities.mdx (1)

27-27: 💤 Low value

Minor inconsistency in example app name.

Line 27 uses myapp:queue while the one-liner examples below (line 90) and the README use tasks:queue. Consider using tasks:queue consistently 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

📥 Commits

Reviewing files that changed from the base of the PR and between a1bf0de and 84c7039.

📒 Files selected for processing (5)
  • README.md
  • docs/content/docs/capabilities.mdx
  • docs/content/docs/getting-started/installation.mdx
  • docs/content/docs/guides/index.mdx
  • docs/content/docs/meta.json

@pratyush618 pratyush618 merged commit 92c52cc into master Jun 1, 2026
16 checks passed
@pratyush618 pratyush618 self-assigned this Jun 1, 2026
@pratyush618 pratyush618 deleted the docs/feature-discoverability branch June 1, 2026 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: improve discoverability of canvas, dashboard, retries, and prefork to preempt repeated misframed audits

1 participant