docs(docs-next): port api reference (phase 3)#115
Merged
pratyush618 merged 2 commits intomasterfrom May 2, 2026
Merged
Conversation
Eight files: api-reference overview + queue/{index,jobs,queues,workers,resources,events}.
Material `:::tip` admonitions become Fumadocs Callouts; mkdocstrings
`::: taskito.X.Y` autodoc directives are dropped (no Fumadocs equivalent
yet); pipe characters in type unions escaped for markdown tables.
Seven pages: task, result, context, canvas, workflows, testing, cli. Canvas mermaid diagrams use the existing <Mermaid> component; warning admonitions become Fumadocs Callouts.
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
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.
Phase 3 of the docs migration — port the full API reference (14 pages, ~2300 lines) from the Zensical site into the new Fumadocs site at `docs-next/`. Zensical site at `docs/` still ships unchanged.
What's ported (14 pages)
Top-level API reference (1 page)
Queue subsection (6 pages, lives at `/docs/api-reference/queue/...`)
Standalone API classes (7 pages)
Conversion rules applied
Design decision: TypeTable deferred
The original plan called for a custom `` component to make every page a single declarative invocation. After surveying the source, I decided to keep markdown tables for now — they render cleanly in MDX, and Fumadocs already ships `` for cases where we want richer type-level UI.
Adopting `` (or a custom ``) wholesale would have made this PR ~3x larger and risked introducing inconsistency mid-port. A follow-up PR can incrementally upgrade the high-traffic constructor + method tables to `` if/when we want the polish, without blocking phase 4.
Test plan
Commits
What's NOT in here (next phases)
LLM-friendly routes← already in template