# xly Wiki

A developer / module-builder wiki for the **xly (小羚羊)** printing-industry ERP framework.

Built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
Markdown source under `docs/`; static HTML generated to `site/` (gitignored).

## What's here

```
xly-wiki/
├── docs/                       ← markdown source — edit these
│   ├── index.md
│   ├── concepts/               (mental model)
│   ├── slices/                 (vertical, end-to-end worked examples)
│   ├── reference/builder/      (recipes for PMs)
│   ├── reference/maintainer/   (internals for Java devs)
│   ├── auto-catalog/           ← machine-generated; do not hand-edit
│   ├── glossary.md
│   └── contributing.md
├── scripts/
│   ├── gen_catalog.py          ← regenerates Auto-Catalog from recon/*.tsv
│   └── precommit.sh            ← optional git hook
├── mkdocs.yml
├── requirements.txt
└── .venv/                      ← gitignored Python venv
```

## Reading the wiki — localhost

Two ways, both equivalent:

```bash
# Live reload while editing (recommended)
source .venv/bin/activate          # if .venv missing: python3 -m venv .venv && pip install -r requirements.txt
mkdocs serve                       # http://127.0.0.1:8000
```

```bash
# One-off build, then open the static HTML directly
mkdocs build                       # writes site/
open site/index.html               # macOS — or just double-click in Finder
```

That's the entire publish story. No CI, no remote hosting, no Pages.
The wiki lives on this machine.

## Out-of-scope

- The B2B printing-platform layer (`plat_*` tables, `xlyPlat*` modules).
- AI / LLM features (`ai_*` tables, `AiController`).
- Face recognition (`xlyFace`).
- Per-tenant schema drift between `xlyweberp_*` databases.

## See also

- `../recon/REPORT.md` — Phase 0 recon report (the design doc this wiki implements).
- `../recon/*.tsv` — offline schema reference (consumed by `scripts/gen_catalog.py`).
- `../xly/` — the codebase this wiki documents.