Documentation Style Guide

Standards and conventions for maintaining MetaPilot's technical documentation suite.

Documentation Conventions

File Naming: Lowercase hyphenated filenames (

getting-started/quickstart.md

architecture/request-lifecycle.md

Directory Hubs: Every folder must contain a
```
README.md
```
file introducing the directory contents and linking files.
File Links: Use relative Markdown links with explicit target basenames:
- Correct:
```
[request-lifecycle.md](architecture/request-lifecycle.md)
```
- Incorrect:
```
[
```
  request-lifecycle.md
```
](architecture/request-lifecycle.md)
```
  (Do not nest backticks inside links).

Use standard GitHub alert syntax to emphasize critical information:

[!NOTE] Architectural context, background information, or general hints.

[!TIP] Best practices, performance optimizations, or developer productivity tips.

[!IMPORTANT] Essential steps, crucial requirements, or key constraints.

[!WARNING] High-risk configurations, potential breaking changes, or deprecations.

[!CAUTION] Actions that could cause data loss or security vulnerabilities.