// xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory.
| name | xlings-docs-writing |
| description | xlings 项目文档编写规范 — 面向人的 docs/ 目录文档应遵循的风格、格式和组织约定。Use when creating or modifying documents in the docs/ directory. |
docs/ 目录下的所有文档。此规范不适用于 .agents/docs/(agent 工作区,格式自由)。
每份文档必须包含:
# 标题
> 编写日期: YYYY-MM-DD | 版本: X.Y.Z
## 第一节
...
### 开始docs/
├── README.md 文档索引(含快速了解 + 分章节目录)
├── architecture/ 系统级全景
├── design/ 子系统设计决策
├── spec/ 接口契约(版本化)
└── guide/ 面向使用者的操作指南
| 层 | 回答什么问题 | 读者 |
|---|---|---|
| architecture | "系统整体是什么样的" | 初次了解项目的人 |
| design | "为什么这样设计" | 需要修改/扩展功能的开发者 |
| spec | "接口契约是什么" | 包作者、Agent 集成者 |
| guide | "怎么操作" | 终端用户 |
subos-as-xpkg.md、xvm-version-management.md.agents/docs/(命名格式 YYYY-MM-DD-xxx.md).agents/docs/ 定稿后升级到 docs/design/xlings 项目贡献规范流程 — 从 issue 到 PR 合入的完整 agent 开发工作流。Use when implementing features, fixing bugs, or contributing code to xlings. Covers environment setup, branching, coding, testing, PR creation, and CI verification.
xlings 包管理器完整使用指南 — 安装、多版本管理、SubOS 隔离环境、项目模式、Agent 集成、包索引生态。Use when tasks involve xlings install/use/search/remove flows, subos lifecycle (new/use/fork/stop/remove), project-mode .xlings.json setup, agent sandbox workflows, or custom index/resource-server configuration.
构建 xlings 项目的三平台操作指南，覆盖 Linux、macOS、Windows 上的工具链准备、`xmake` 配置、release 脚本构建和构建后验证。Use this skill when Codex needs to build, package, or verify xlings locally or in CI, especially when aligning with `.github/workflows/*` and `tools/*_release.*`, or when setting up musl-gcc / LLVM / MSVC toolchains for this repository.
使用 xlings (XLINGS Quickstart) 进行工具安装、版本管理、包索引扩展和 subos 环境隔离的操作指南。When tasks involve `xlings`/`xim` package install-search-update-remove flows, namespace package handling, self-hosted/custom index repo setup, or multi-version/subos troubleshooting, use this skill.