Documentation Map
August 20, 2026 · View on GitHub
English is the primary language of GitLearnOS. Human-facing entry points are kept clear in both English and Chinese. Machine-facing contracts are maintained in English first and do not require a Chinese duplicate.
flowchart LR
H["Learner or judge"] --> W["Website"] --> R["README"] --> Q["Quickstart"] --> D["Live demo"]
A["Agent or maintainer"] --> G["AGENTS.md"] --> P["GITLEARNOS.md"] --> S["One Skill"] --> L["Learner repository"]
Start here
| Need | English | Chinese |
|---|---|---|
| Understand the product | README | 中文 README |
| Start using it | Quickstart | 快速开始 |
| See a real Agent loop | Live demo | 三分钟演示 |
| Resolve common questions | FAQ | 常见问题 |
| Configure a no-Skill surface | Project instructions | 项目自定义指令 |
| Configure cross-chat activation | Memory pointer | 原生记忆指针 |
| Record verified recurring tasks | Automation state | 自动化状态 |
| Add optional local knowledge retrieval | RAG-Anything card | RAG-Anything 部署卡 |
| Use DeepSeek Harness Developer Preview | Harness adapter | Harness 适配器 |
| Share the DeepSeek Harness release | Launch note | 发布说明 |
| Read the AceSAT case | Impact statement | 影响说明 |
| Browse the visual site | Website | Use the 中 switch on the same page |
These entry points are the supported human path. A learner or judge should not need to read the protocol, Skills, adapters, or evaluation fixtures to understand the product.
Machine-facing path
The executable reading order is:
AGENTS.md
→ GITLEARNOS.md
→ skills/gitlearnos/SKILL.md
→ one focused reference
→ learner repository
skills/gitlearnos/ is one installable bundle: only its Router is discoverable,
while operations and subject methods load from references/ on demand.
GITLEARNOS.md is the canonical behavior contract. AGENTS.md, skills/,
evals/, adapters, and machine templates are maintained in English. Existing
Chinese translations may help a human inspect the system, but they are not
required for every machine-facing file and never override the English source.
DeepSeek Harness users install the repository root as a pinned Developer Preview bundle, then verify its profile configuration and client learning panel. The bundle has a read-only agent-maintained learning queue, two read tools, and one narrow Git event transaction; its exact install, removal, verification, safety, model, schedule, and roadmap boundaries are in the Harness adapter guide.
Deeper documentation
Files under docs/ explain architecture, automation, privacy, deployment,
memory, and learning methods. English versions are primary. A Chinese
counterpart may be provided when the document is part of a common human
workflow; advanced implementation notes may remain English-only. The
diagnostic write barrier is explained in
Differential diagnosis.
Locale layout and alignment
All Chinese-localized content lives under the single root zh-CN/ tree. A
translation mirrors the English relative path whenever possible:
docs/architecture.md
↔ zh-CN/docs/architecture.md
Every Markdown file in the installable skills/gitlearnos/ bundle has a
required same-path Chinese reading version under zh-CN/skills/gitlearnos/.
Stable names, paths, status values, and output fields remain in English;
explanatory prose is translated. The root English GITLEARNOS.md remains the
sole canonical protocol.
The Chinese Zhongkao example is localized content rather than a line-by-line translation, so it intentionally has no exact English mirror. See the Chinese alignment rules.
Writing standard
Human-facing documentation must:
- lead with the outcome and a concrete example;
- use ordinary language before internal terms;
- distinguish required, optional, and unavailable capabilities;
- link to the next action instead of duplicating the whole protocol;
- keep English and Chinese meaning aligned without literal, unnatural translation.
When a human-facing pair changes, update both files in the same change. Machine files change in English first; translate them only when the translation has a real reader and can be kept accurate.