Guide
Guide
How to write documentation for the site, add a project to it, preview a build and fix a failing check.
On this page
The guide follows a project from its first page to its fiftieth release. Each page stands alone.
| Page | Read it when |
|---|---|
| Writing documentation | You are writing or moving Markdown into a project's docs/ folder. |
| Adding a project | A repository should appear on the site, or stop appearing on it. |
| Previewing | You want to see your pages as the site will build them, before you merge. |
| Troubleshooting | A build or a check failed, or a page looks wrong. |
The reference has the complete lists: every command, option, exit code, registry key and check.