← Authoring guideMarkdown template
Copy, adapt, and trim
Project template
Use this file as a starting point. Keep only sections with useful, sourced content.
# Project name
One-sentence description and current status.
## Overview
What it does, where it fits, and important scope limits.
## Setup
Prerequisites and verified installation or first-run steps.
## Configuration
Configuration files, supported options, and safe defaults.
## Usage
Common workflows and concise examples.
## Troubleshooting
Observed symptoms, verified causes, and recovery steps.
## References
Source repository, upstream documentation, and related wiki pages.