Content workspace

Route/authoring/scribe PreviewScribe previewscribe

The Content Workspace is where reference documentation is written by hand: a tree of the version's targets on the left, an editor for the selected target in the centre, and the Proposals and evidence inspector on the right. Without a scope: "Choose a project and version in the header to open its content…"

The content tree

The Content pane lists the version's paths and a Schemas group, filtered by format — All formats, OpenAPI, Arazzo, AsyncAPI, GraphQL, gRPC, JSON Schema, Guide — and by status chip: All, Needs attention, Undocumented, Stale, In review. A note says when a filter is active. If the catalog cannot be read: "The catalog could not be read, so the content tree is unavailable. This is not an empty catalog…"

The editor

Three views — Edit, Preview (the rendered reference, with empty fields shown as explicitly missing) and Changes (a diff of the description, Saved against Your draft; also where a conflict is resolved) — and the actions:

Action	Behaviour
Save (Ctrl / ⌘+S)	Re-reads the server copy and compares revisions first; a copy that moved becomes a Conflict rather than an overwrite. Disabled with "Select a target in the content tree first.", "There are no changes to save." or "A save is already in flight."
Revert	Asks for confirmation
Request review	Disabled in this preview: "Review routing needs the collaboration backend, which this app cannot reach yet…"
Generate all	Opens the generation sheet (below)

Leaving with unsaved edits triggers the browser's leave-page prompt. The empty editor reads "Select a target in the content tree to start writing." or "No targets match this filter. Clear it to see the whole catalog."

The editor's shape follows the target:

• Operation or workflow (OpenAPI, Arazzo): Prev and Next step through the undocumented targets ("N of M"), with a narrative per response status. Each field has a Generate button, disabled in this preview with a note that the per-field suggestion engine is not wired yet.
• Schema or message: an Example payload with Generate from schema (a deterministic render of the schema — no model) and Copy; the property list with Generate All, per-row Generate and Try again (disabled, same note); and Accept, Edit first and Save All Accepted for suggestions that do reach the session.
• Generic fields for the other formats.

Proposals and evidence

The inspector (a drawer on narrower windows) has four sections: State, Proposals, Spec context ("What suggestions for this target are grounded in.") and Validation, with the model and policy named above the proposals. A proposal card offers Accept, Edit, Reject and Regenerate. In this preview the per-target proposal path is not connected, so the section reads "No proposals have been generated for this target…"; proposals reach you through the bulk jobs and stale alerts instead.

The generation sheet

Generate all opens Generate documentation — "Nothing runs and nothing is spent until you start." It shows Scope and cost, a Policy choice — Grounded (citations required, the larger model, a per-target price) or Draft (the smaller model, cheaper) — Progress and Failed targets, with Stop and Retry N failed. Its start button is disabled in this preview; run generation from the dashboard or the project overview instead.

Where it writes

The workspace reads and writes the Designer catalog — path summaries and descriptions, class descriptions — through the Apiome REST API, so an edit here is visible on the Designer canvas and in every export at once. It is read-only on a published version or in the Production environment.