FAQ Template
A repeatable structure for FAQ question, answer, category, related service, and SEO context.
Back to Templates
Custom Content Types
Documentation Article Template
A content structure for product documentation and help articles — summary, prerequisites, ordered steps, examples, and related links, kept consistent as a Custom Content Type.
1
When to use this template
Use this structure for product documentation and help articles published as a Custom Content Type, so every document shares the same backbone.
Consistent documentation is faster to write, easier for Client Reviewers to check, and simpler to keep current as the product changes.
2
Suggested fields
A starting set of fields for this structure. Adapt the labels, keys, and which fields are required to match your project.
Field labelField keyTypeStatus
TitletitletextRequired
SummarysummarytextareaRequired
CategorycategoryselectRequired
PrerequisitesprerequisiteslistOptional
BodybodyMDXRequired
Related ArticlesrelatedArticleslistOptional
SEO TitleseoTitletextSEO
Meta DescriptionmetaDescriptiontextareaSEO
3
Required fields
The minimum fields every item should have before it can move to review.
Field labelField keyTypeStatus
TitletitletextRequired
SummarysummarytextareaRequired
CategorycategoryselectRequired
BodybodyMDXRequired
4
Optional fields
Useful additions you can include per item, or leave out when they don't apply.
Field labelField keyTypeStatus
PrerequisitesprerequisiteslistOptional
Related ArticlesrelatedArticleslistOptional
5
SEO fields
Search metadata for the item. Keep titles and descriptions unique per item.
Field labelField keyTypeStatus
SEO TitleseoTitletextSEO
Meta DescriptionmetaDescriptiontextareaSEO
6
Example content item
titleConnect a repository
summaryConnect your GitHub repository through the GitHub App.
categoryGetting started
prerequisitesA GitHub account, a repository
7
Markdown / MDX frontmatter example
How the structure looks as frontmatter in a Git-backed content file. Field keys map directly to your content type.
---
title: "Connect a repository"
summary: "Connect your GitHub repository through the GitHub App."
category: "Getting started"
seoTitle: "Connect a repository"
---
## Before you start
Content body…8
Review & publishing checklist
Confirm these before publishing the item through GitHub. The trigger result is recorded in Publish Logs.
All required fields completedFill every field marked Required before moving to review.
Featured Image reference resolvesConfirm the media path exists in your repo.
SEO Title and Meta Description setWithin recommended length, unique per item.
Sent to Client Reviewers for approvalAdd review context so reviewers know what changed.
Scheduled or ready to publishConfirm date, time, and timezone if scheduling.
Deployment trigger profile configuredTrigger result is recorded in Publish Logs after publishing.
Turn templates into a publishing workflow.
Use Acrosite to create the structure, review content, schedule publishing, and keep output in GitHub.