Quickstart

Learn to set up and use Brief effectively.

Basic Usage#

Use CLI commands like brief page create and brief version remove to manage elements pages, tabs, versions, and locales.
Page contents are written manually by editing index.<locale>.md files for each page. Brief uses Comark's markdown format.
Use brief check to lint your docs for broken links and other SEO issues.

Agents excel at CLI usage - it's often faster to ask them to manage the documentation and fix issues for you.
Brief ships with skills like /brief, /update-docs, and /thermonuclear-seo-docs-review to help your agents. Make sure they're being detected.
Agents are not so great at organizing concepts or getting your writing style quite right. It's usually better to write a few pages first and then ask them to maintain and extend them rather than starting from scratch.