# SilkPrint Technical Documentation

Technical documentation for the SilkPrint project — written alongside the code and
published automatically to GitLab Pages after merge.

## How it works

```
MR template (capture)  →  docs/ folder (store, versioned with code)  →  CI → GitLab Pages (publish)
```

- **[Modules](modules/index.md)** — how a module works: purpose, configuration,
  integration points, testing.
- **[Fixes](fixes/index.md)** — one page per bug fix: problem, root cause, what
  changed, verification.

## Authoring a page

You rarely write these by hand. At the end of a branch, run the Claude Code skill:

| Situation | Command |
|-----------|---------|
| New module / feature | `/document-change feature` |
| Finished sprint / hotfix branch | `/document-change fix` |
| Long-lived milestone branch | `/document-change fix --since <tag\|sha>` |

To create a page manually, copy the relevant `TEMPLATE.md`
(`docs/modules/TEMPLATE.md` or `docs/fixes/TEMPLATE.md`) to a new file in the same
folder and fill it in. `TEMPLATE.md` files are excluded from the published site.

## One important habit

Include the issue ID in every fix commit so each bug fix documents separately and
without duplication:

```
fix: #1234 cart total wrong with tax
```