Understand
Publishing lifecycle
Understand documents, immutable revisions, asynchronous jobs, and private artifacts.
Documents and revisions
A document is the long-lived managed identity. Each edit creates an immutable revision, so a published artifact can always be traced to the exact Markdown and rendering specification that produced it.
Jobs are asynchronous
Preview and final publication requests return jobs. Poll a job until succeeded, failed, or cancelled; do not assume that an accepted request has already produced a file.
- queued and running are non-terminal
- succeeded includes the resulting artifact identity
- failed includes a stable error contract
- cancelled is terminal and cannot be resumed
Private artifacts
Artifacts are private and retained for the period declared in their response contract. Create a short-lived link only when the file is ready to be consumed.