Skip to content

Document

One piece of content in a Collection: a page, a post, a docs article, a changelog entry or a help article, in Markdown, with a status from draft to published, authors, SEO metadata and an optional parent for hierarchies.

PackContent
Versionv1 (latest)
URNurn:postware:content:document
Identitycollection + slug + locale
Status categoriesdraft, review, published, archived

Fields

FieldTypeReqNotes
collectionRef<Collection>yes
titlestringyes
slugstringyespattern ^[a-z0-9]+(-[a-z0-9]+)*$
bodytextnoMarkdown; a source's native rich text stays in source.payload
summarytextno
statusStatus(draft|review|published|archived)yesdefault map[category:draft]
published_atdatetimenoset by the server on the first transition to published when absent; a future value schedules
authorsRef<Member | Person>[]yesat least one
coverRef<File>no
seoSEOno
localestringnoBCP 47
parentRef<Document>nodocs hierarchy
orderintno

Events

document.published when status.category becomes published.