xly Wiki

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

Built with 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
├── .github/workflows/publish.yml  (GitHub Actions: builds + publishes site/)
└── .venv/                      ← gitignored Python venv

Quick start

source .venv/bin/activate          # if .venv missing: python3 -m venv .venv && pip install -r requirements.txt
mkdocs serve                       # http://127.0.0.1:8000 with live reload

Publishing

The repo is initialised but not yet pushed to a remote. To publish:

git remote add origin <your-remote-url>
git push -u origin main

Once the repo lives at a GitHub URL with Pages enabled (Settings → Pages → Source: GitHub Actions), the workflow at .github/workflows/publish.yml will build and deploy the static site on every push to main.

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.