Skip to content

Documentation Page Template

About this template

Copy and customize this template when writing a new documentation page for SkyCMS.Docs. It defines the standard structure, required frontmatter comments, and section conventions used across the docs site.


Template

Copy everything below this line into a new .md file and fill in the bracketed sections.


<!-- Audience: [Audience group — e.g., Content Editors, Site Builders, Developers, All] -->
<!-- Type: [Explanation | How-to | Reference | Quick Start | Overview] -->
<!-- Status: Draft -->
<!-- Source: [Source file or feature — e.g., SkyCMS/Editor/Controllers/...] -->

# <Doc title>

> 2–3 sentences that summarize the purpose and outcome.

## When to use this page

- Who and the scenario where this doc applies.
- Preconditions or environment.

## Why this matters

- Value or risk addressed; be concrete (latency, cost, reliability, compliance, UX).

## Key takeaways

- 3–5 bullets of plain-language conclusions or do/don'ts.

## Prerequisites

- Accounts, roles, tools, versions, and data needed.

## Quickstart / Steps

1. Step-by-step path to success (keep concise; link to deep dives if long).
2. Call out checkpoints or expected outputs.

## Troubleshooting

- Common failure modes with short fixes or links.

## Related guides

- Closest next docs (guides, API refs, checklists).

## FAQ (optional)

- Q: … A: …

## Changelog (optional)

- 2026-01-03: Created.