Metal3 Documentation - AI Agent Instructions

Instructions for AI coding agents. For project overview, see README.md.

Overview

Central documentation repository for Metal3, published at https://book.metal3.io. Uses mdBook static site generator.

Repository Structure

Directory	Purpose
`docs/user-guide/`	Main user documentation (mdBook source)
`design/`	Design proposals and architecture docs
`processes/`	Project processes (release, security)
`security/`	Security policies and advisories
`hack/`	CI scripts (markdownlint, spellcheck, shellcheck)

Testing Standards

CI uses GitHub Actions. Run locally before PRs:

Command	Purpose
`make lint`	Run all linters (markdown, spell, shell)
`make serve`	Serve docs locally on port 3000
`make build`	Build static site
`./hack/markdownlint.sh`	Markdown linting
`./hack/spellcheck.sh`	Spell checking (cspell)

Code Conventions

Markdown: Config in
```
.markdownlint-cli2.yaml
```
Spelling: Custom dictionary in
```
.cspell-config.json
```
Links: Checked by lychee (
```
.lycheeignore
```
for exceptions)

Adding Documentation

Create/edit Markdown in
```
docs/user-guide/src/
```
Update
```
SUMMARY.md
```
if adding new pages
Run
```
make serve
```
to preview
Run
```
make lint
```
before committing

Code Review Guidelines

When reviewing pull requests:

Accuracy - Technical content must be correct and up-to-date
Clarity - Clear language, good examples
Links - No broken internal/external links
Spelling - No typos (add technical terms to
```
.cspell-config.json
```
)

AI Agent Guidelines

Run
```
make lint
```
before committing
Update
```
.cspell-config.json
```
for new technical terms
Keep docs in sync with actual component behavior
Cross-link related pages

Metal3 Documentation - AI Agent Instructions

Instructions for AI coding agents. For project overview, see README.md.

Overview

Central documentation repository for Metal3, published at https://book.metal3.io. Uses mdBook static site generator.

Repository Structure

Directory	Purpose
`docs/user-guide/`	Main user documentation (mdBook source)
`design/`	Design proposals and architecture docs
`processes/`	Project processes (release, security)
`security/`	Security policies and advisories
`hack/`	CI scripts (markdownlint, spellcheck, shellcheck)

Testing Standards

CI uses GitHub Actions. Run locally before PRs:

Command	Purpose
`make lint`	Run all linters (markdown, spell, shell)
`make serve`	Serve docs locally on port 3000
`make build`	Build static site
`./hack/markdownlint.sh`	Markdown linting
`./hack/spellcheck.sh`	Spell checking (cspell)

Code Conventions

Markdown: Config in
```
.markdownlint-cli2.yaml
```
Spelling: Custom dictionary in
```
.cspell-config.json
```
Links: Checked by lychee (
```
.lycheeignore
```
for exceptions)

Adding Documentation

Create/edit Markdown in
```
docs/user-guide/src/
```
Update
```
SUMMARY.md
```
if adding new pages
Run
```
make serve
```
to preview
Run
```
make lint
```
before committing

Code Review Guidelines

When reviewing pull requests:

Accuracy - Technical content must be correct and up-to-date
Clarity - Clear language, good examples
Links - No broken internal/external links
Spelling - No typos (add technical terms to
```
.cspell-config.json
```
)

AI Agent Guidelines

Run
```
make lint
```
before committing
Update
```
.cspell-config.json
```
for new technical terms
Keep docs in sync with actual component behavior
Cross-link related pages

Metal3 Documentation - AI Agent Instructions

Metal3 Documentation - AI Agent Instructions

Overview

Repository Structure

Testing Standards

Code Conventions

Adding Documentation

Code Review Guidelines

AI Agent Guidelines

Related Skills

Markdown Converter

Nano Banana Pro

1password

Metal3 Documentation - AI Agent Instructions

Overview

Repository Structure

Testing Standards

Code Conventions

Adding Documentation

Code Review Guidelines

AI Agent Guidelines