Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.steppd.com/llms.txt

Use this file to discover all available pages before exploring further.

Steppd gives every document a version field and keeps a complete record of what each version contained before it was replaced. When a published document needs to be updated, you create a revision, a new draft that goes through the same review and publish workflow as the original, while the previous version is preserved in revision history. This gives your team a traceable record of every process change without any manual bookkeeping.

​
The version field

Each document has a version field, a free-text label such as 1.0, 2.1, or v3, that you set when creating or editing a document. The version appears alongside the document title in your library and in every revision history record. When you create a revision of a published document, Steppd requires you to set a new version label that is different from the one currently published. This prevents two active versions of the same document from sharing the same label.
The version field is optional on a draft. You can leave it blank and add it before publishing, but setting it early helps your team know which version is in progress.

​
How revisions work

Revising a document creates a new draft linked to the original published document. The original is not deleted, it moves into revision history so you can always view what was previously in effect.
1

Start a revision

From your document list, open the action menu on a published document and select Revise. Steppd creates a new draft pre-populated with the title, department, and version of the original.
2

Update the version

Set a new version label on the draft before publishing. It must be different from the version currently published.
3

Edit the draft

Make your changes in the editor. The draft goes through the same workflow as any other draft, only the owner and any assigned co-author can edit it.
4

Publish the revision

When the draft is ready, publish it. The new version becomes the active published document. The previous published version is recorded in revision history with its publication date and the date it was superseded.
Publishing a revision fires the document.revised webhook event. If you have integrations connected, they will receive the updated document content automatically.

​
Revision history

Every published document has a revision history page. Open the action menu on a published document and select View History to see it. This page lists every previous version of the document in chronological order, showing the version label, the date it was published, and the date it was superseded. You can open any historical version to read its content. Historical versions are read-only, they cannot be edited or re-published directly. To revert to a previous version, create a new revision and copy the content you need from the historical record. Each entry in revision history records:
  • Title, the document title at the time of that version
  • Version, the version label
  • Published date, when that version was published
  • Superseded date, when that version was replaced by the next revision

​
Webhook events for version changes

Steppd fires webhook events at each stage of the document lifecycle. Use these to keep external systems, vector databases, wikis, notification tools, automatically in sync.
EventWhen it fires
document.publishedA draft is published for the first time
document.revisedA revision is published, replacing the previous version
document.archivedA document is archived
Webhooks are available on the Scale plan. See Webhooks for setup instructions.
You can also trigger webhook events manually from the action menu on any published document using Trigger Webhooks. This is useful for re-sending a document to a connected system without making a content change.

​
Archives

Archiving retires a document from your active library. Archived documents are removed from My documents and moved to Archives, which you can access from the sidebar. Archives are a permanent record, archived documents are not deleted. You can navigate to Archives at any time to view a past document, including its version label and the date it was archived.
Archive a document when the process it describes is no longer in use but you want to keep a record of it, for compliance, audits, or future reference. Delete a draft only when it was created by mistake and has no value to retain.
Archived documents are read-only in Archives. To bring a retired process back into use, create a new document and use the archived version as a reference for the content.
Yes. Archiving a document fires the document.archived webhook event to any connected endpoints that subscribe to it.