Skip to content

Replace <TSDoc> component with typedoc-generated API reference pages #1611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TooTallNate wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Replace <TSDoc> component with typedoc-generated API reference pages #1611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ packages/swc-plugin-workflow/build-hash.json

.DS_Store

# TypeDoc generated output
/packages/*/typedoc-out
/packages/*/typedoc-out-api

# Generated manifest files copied to static asset directories by builders
workbench/nextjs-*/public/.well-known/workflow
workbench/sveltekit/static/.well-known/workflow
Expand Down
3 changes: 3 additions & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ yarn-error.log*
*.tsbuildinfo
next-env.d.ts

# typedoc-generated API reference pages
/content/docs/api-reference/*/api/

# pagefind
_pagefind/

Expand Down
2 changes: 0 additions & 2 deletions docs/app/[lang]/docs/[[...slug]]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import * as AccordionComponents from '@/components/ui/accordion';
import { Badge } from '@/components/ui/badge';
import { Separator } from '@/components/ui/separator';
import { getLLMText, getPageImage, source } from '@/lib/geistdocs/source';
import { TSDoc } from '@/lib/tsdoc';

// No-op component for world MDX files rendered outside /worlds/ context
// These pages redirect to /worlds/[id] but still get statically generated
Expand Down Expand Up @@ -70,7 +69,6 @@ const Page = async ({ params }: PageProps<'/[lang]/docs/[[...slug]]'>) => {
AgentTraces,
FluidComputeCallout,
Badge,
TSDoc,
Step,
Steps,
...AccordionComponents,
Expand Down
4 changes: 4 additions & 0 deletions docs/content/docs/api-reference/vitest/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "@workflow/vitest",
"pages": ["...", "--- Generated API Reference ---", "...api"]
}
84 changes: 14 additions & 70 deletions docs/content/docs/api-reference/workflow-ai/durable-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,141 +63,85 @@ async function myAgent() {

### Class

<TSDoc
definition={`
import { DurableAgent } from "@workflow/ai/agent";
export default DurableAgent;`}
/>
> See the full API reference for [`DurableAgent`](/docs/api-reference/workflow-ai/api/agent/durable-agent/classes/DurableAgent).

### DurableAgentOptions

<TSDoc
definition={`
import type { DurableAgentOptions } from "@workflow/ai/agent";
export default DurableAgentOptions;`}
/>
> See the full API reference for [`DurableAgentOptions`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/DurableAgentOptions).

### DurableAgentStreamOptions

<TSDoc
definition={`
import type { DurableAgentStreamOptions } from "@workflow/ai/agent";
export default DurableAgentStreamOptions;`}
/>
> See the full API reference for [`DurableAgentStreamOptions`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/DurableAgentStreamOptions).

### DurableAgentStreamResult

The result returned from the `stream()` method:

<TSDoc
definition={`
import type { DurableAgentStreamResult } from "@workflow/ai/agent";
export default DurableAgentStreamResult;`}
/>
> See the full API reference for [`DurableAgentStreamResult`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/DurableAgentStreamResult).

### GenerationSettings

Settings that control model generation behavior. These can be set on the constructor or overridden per-stream call:

<TSDoc
definition={`
import type { GenerationSettings } from "@workflow/ai/agent";
export default GenerationSettings;`}
/>
> See the full API reference for [`GenerationSettings`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/GenerationSettings).

### PrepareStepInfo

Information passed to the `prepareStep` callback:

<TSDoc
definition={`
import type { PrepareStepInfo } from "@workflow/ai/agent";
export default PrepareStepInfo;`}
/>
> See the full API reference for [`PrepareStepInfo`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/PrepareStepInfo).

### PrepareStepResult

Return type from the `prepareStep` callback:

<TSDoc
definition={`
import type { PrepareStepResult } from "@workflow/ai/agent";
export default PrepareStepResult;`}
/>
> See the full API reference for [`PrepareStepResult`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/PrepareStepResult).

### TelemetrySettings

Configuration for observability and telemetry:

<TSDoc
definition={`
import type { TelemetrySettings } from "@workflow/ai/agent";
export default TelemetrySettings;`}
/>
> See the full API reference for [`TelemetrySettings`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/TelemetrySettings).

### Callbacks

#### StreamTextOnFinishCallback

Called when streaming completes:

<TSDoc
definition={`
import type { StreamTextOnFinishCallback } from "@workflow/ai/agent";
export default StreamTextOnFinishCallback;`}
/>
> See the full API reference for [`StreamTextOnFinishCallback`](/docs/api-reference/workflow-ai/api/agent/durable-agent/type-aliases/StreamTextOnFinishCallback).

#### StreamTextOnErrorCallback

Called when an error occurs:

<TSDoc
definition={`
import type { StreamTextOnErrorCallback } from "@workflow/ai/agent";
export default StreamTextOnErrorCallback;`}
/>
> See the full API reference for [`StreamTextOnErrorCallback`](/docs/api-reference/workflow-ai/api/agent/durable-agent/type-aliases/StreamTextOnErrorCallback).

#### StreamTextOnAbortCallback

Called when the operation is aborted:

<TSDoc
definition={`
import type { StreamTextOnAbortCallback } from "@workflow/ai/agent";
export default StreamTextOnAbortCallback;`}
/>
> See the full API reference for [`StreamTextOnAbortCallback`](/docs/api-reference/workflow-ai/api/agent/durable-agent/type-aliases/StreamTextOnAbortCallback).

### Advanced Types

#### ToolCallRepairFunction

Function to repair malformed tool calls:

<TSDoc
definition={`
import type { ToolCallRepairFunction } from "@workflow/ai/agent";
export default ToolCallRepairFunction;`}
/>
> See the full API reference for [`ToolCallRepairFunction`](/docs/api-reference/workflow-ai/api/agent/durable-agent/type-aliases/ToolCallRepairFunction).

#### StreamTextTransform

Transform applied to the stream:

<TSDoc
definition={`
import type { StreamTextTransform } from "@workflow/ai/agent";
export default StreamTextTransform;`}
/>
> See the full API reference for [`StreamTextTransform`](/docs/api-reference/workflow-ai/api/agent/durable-agent/type-aliases/StreamTextTransform).

#### OutputSpecification

Specification for structured output parsing:

<TSDoc
definition={`
import type { OutputSpecification } from "@workflow/ai/agent";
export default OutputSpecification;`}
/>
> See the full API reference for [`OutputSpecification`](/docs/api-reference/workflow-ai/api/agent/durable-agent/interfaces/OutputSpecification).

## Key Features

Expand Down
4 changes: 4 additions & 0 deletions docs/content/docs/api-reference/workflow-ai/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "@workflow/ai",
"pages": ["...", "--- Generated API Reference ---", "...api"]
}
12 changes: 2 additions & 10 deletions docs/content/docs/api-reference/workflow-ai/workflow-chat-transport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,11 @@ export default function Chat() {

### Class

<TSDoc
definition={`
import { WorkflowChatTransport } from "@workflow/ai";
export default WorkflowChatTransport;`}
/>
> See the full API reference for [`WorkflowChatTransport`](/docs/api-reference/workflow-ai/api/index/classes/WorkflowChatTransport).

### WorkflowChatTransportOptions

<TSDoc
definition={`
import type { WorkflowChatTransportOptions } from "@workflow/ai";
export default WorkflowChatTransportOptions;`}
/>
> See the full API reference for [`WorkflowChatTransportOptions`](/docs/api-reference/workflow-ai/api/index/interfaces/WorkflowChatTransportOptions).

## Key Features

Expand Down
16 changes: 2 additions & 14 deletions docs/content/docs/api-reference/workflow-api/get-hook-by-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,11 @@ export async function POST(request: Request) {

### Parameters

<TSDoc
definition={`
import { getHookByToken } from "workflow/api";
export default getHookByToken;`}
showSections={["parameters"]}
/>
> See the full API reference for [`getHookByToken`](/docs/api-reference/workflow-api/api/functions/getHookByToken).

### Returns

Returns a `Promise<Hook>` that resolves to:

<TSDoc
definition={`
import type { Hook } from "@workflow/world";
export default Hook;`}
showSections={["returns"]}
/>
Returns a `Promise<Hook>` that resolves to the hook object with run and metadata information.

## Examples

Expand Down
38 changes: 6 additions & 32 deletions docs/content/docs/api-reference/workflow-api/get-run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,59 +21,33 @@ const run = getRun("my-run-id");

### Parameters

<TSDoc
definition={`
import { getRun } from "workflow/api";
export default getRun;`}
showSections={["parameters"]}
/>
> See the full API reference for [`getRun`](/docs/api-reference/workflow-api/api/functions/getRun).

### Returns

Returns a `Run` object:

<TSDoc
definition={`
import { Run } from "workflow/api";
export default Run;`}
showSections={["returns"]}
/>
> See the full API reference for [`Run`](/docs/api-reference/workflow-api/api/classes/Run).

#### WorkflowReadableStream

`run.getReadable()` returns a `WorkflowReadableStream` — a standard `ReadableStream` extended with a `getTailIndex()` helper:

<TSDoc
definition={`
import type { WorkflowReadableStream } from "workflow/api";
export default WorkflowReadableStream;`}
/>
> See the full API reference for [`WorkflowReadableStream`](/docs/api-reference/workflow-api/api/type-aliases/WorkflowReadableStream).

`getTailIndex()` returns the index of the last known chunk (0-based), or `-1` when no chunks have been written. This is useful when building [reconnection endpoints](/docs/ai/resumable-streams) that need to inform clients where the stream starts.

#### WorkflowReadableStreamOptions

<TSDoc
definition={`
import type { WorkflowReadableStreamOptions } from "workflow/api";
export default WorkflowReadableStreamOptions;`}
/>
> See the full API reference for [`WorkflowReadableStreamOptions`](/docs/api-reference/workflow-api/api/interfaces/WorkflowReadableStreamOptions).

#### StopSleepOptions

<TSDoc
definition={`
import type { StopSleepOptions } from "workflow/api";
export default StopSleepOptions;`}
/>
> See the full API reference for [`StopSleepOptions`](/docs/api-reference/workflow-api/api/interfaces/StopSleepOptions).

#### StopSleepResult

<TSDoc
definition={`
import type { StopSleepResult } from "workflow/api";
export default StopSleepResult;`}
/>
> See the full API reference for [`StopSleepResult`](/docs/api-reference/workflow-api/api/interfaces/StopSleepResult).

## Examples

Expand Down
9 changes: 1 addition & 8 deletions docs/content/docs/api-reference/workflow-api/get-world.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,7 @@ This function does not accept any parameters.

### Returns

Returns a `World` object:

<TSDoc
definition={`
import type { World } from "@workflow/world";
export default World;`}
showSections={["returns"]}
/>
Returns the [`World`](/docs/deploying/building-a-world) instance.

## World SDK

Expand Down
4 changes: 4 additions & 0 deletions docs/content/docs/api-reference/workflow-api/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "workflow/api",
"pages": ["...", "--- Generated API Reference ---", "...api"]
}
16 changes: 2 additions & 14 deletions docs/content/docs/api-reference/workflow-api/resume-hook.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,11 @@ export async function POST(request: Request) {

### Parameters

<TSDoc
definition={`
import { resumeHook } from "workflow/api";
export default resumeHook;`}
showSections={["parameters"]}
/>
> See the full API reference for [`resumeHook`](/docs/api-reference/workflow-api/api/functions/resumeHook).

### Returns

Returns a `Promise<Hook>` that resolves to:

<TSDoc
definition={`
import type { Hook } from "@workflow/world";
export default Hook;`}
showSections={["returns"]}
/>
Returns a `Promise<Hook>` that resolves to the hook object with run and metadata information.

## Examples

Expand Down
7 changes: 1 addition & 6 deletions docs/content/docs/api-reference/workflow-api/resume-webhook.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,7 @@ export async function POST(request: Request) {

### Parameters

<TSDoc
definition={`
import { resumeWebhook } from "workflow/api";
export default resumeWebhook;`}
showSections={['parameters']}
/>
> See the full API reference for [`resumeWebhook`](/docs/api-reference/workflow-api/api/functions/resumeWebhook).

### Returns

Expand Down
Loading
Loading