Name Last Update
..
docs Loading commit data...
scripts Loading commit data...
.gitignore Loading commit data...
README.md Loading commit data...
mkdocs.yml Loading commit data...
requirements.txt Loading commit data...

README.md

xly Wiki(简体中文)

面向 xly(小羚羊) 印刷行业 ERP 框架的开发者 / 模块配置人员 Wiki。

使用 MkDocs Material 构建。 Markdown 源文件在 docs/ 下;静态 HTML 生成到 ../site/zh/(已被 git 忽略)。

内容结构

xly-wiki/zh/
├── docs/                       ← markdown 源文件,编辑这里
│   ├── index.md
│   ├── concepts/               (心智模型)
│   ├── slices/                 (端到端纵向切片)
│   ├── reference/builder/      (面向 PM / 实施的操作说明)
│   ├── reference/maintainer/   (面向 Java 开发的内部机制)
│   ├── auto-catalog/           ← 机器生成,不手工编辑
│   ├── glossary.md
│   └── contributing.md
├── scripts/
│   ├── gen_catalog.py          ← 从 recon/*.tsv 或数据库重新生成自动目录
│   └── precommit.sh            ← 可选 git hook
├── mkdocs.yml
├── requirements.txt
└── ../.venv/                   ← repo 根目录下 git 忽略的 Python 虚拟环境

本地阅读

两种方式等价:

# 编辑时实时预览
../.venv/bin/mkdocs serve          # http://127.0.0.1:8000
# 一次性构建,然后直接打开静态 HTML
../.venv/bin/mkdocs build          # 写入 ../site/zh/
open ../site/zh/index.html         # macOS;也可以在 Finder 中双击

发布方式仅限本机:没有 CI、没有远程托管、没有 Pages。

不覆盖的范围

  • B2B 印刷平台层(plat_* 表、xlyPlat* 模块)。
  • AI / LLM 功能(ai_* 表、AiController)。
  • 人脸识别(xlyFace)。
  • xlyweberp_* 数据库之间的租户级 schema 漂移。

相关资料

  • ../../recon/REPORT.md:Phase 0 侦察报告,也是本 Wiki 的设计输入。
  • ../../recon/*.tsv:离线 schema 参考,由 scripts/gen_catalog.py 消费。
  • ../../xly/:本 Wiki 所记录的代码库。