From 914567926191d453b6123b5a4bcf8e3e99425547 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E7=94=B5=E8=8A=BD=E8=A1=A3?= Date: Mon, 24 Aug 2026 22:17:32 -0400 Subject: [PATCH] Document the OmarchyCN layer in AGENTS.md Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01QKxGW1raAWaqeU8WdHsMsp --- AGENTS.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index e4a0084e..3061afea 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -11,13 +11,25 @@ matching guide before starting: - [`agents/skills/visual-verification.md`](agents/skills/visual-verification.md) - verifying any change with a visual effect in the running UI - [`agents/skills/migrations.md`](agents/skills/migrations.md) - creating or changing migrations under `migrations/` +# OmarchyCN Layer + +This fork carries the OmarchyCN China-integration layer on top of upstream `basecamp/omarchy`: + +- `bin/omarchycn` routes to `omarchy cn `; all cn commands are `bin/omarchy-cn-*` and follow every upstream bin convention (metadata, helpers, `$OMARCHY_PATH`) +- `cn/` holds the data layer: `mirrors.json`, `dev-mirrors.json`, `apps.json`, `registry/` (AI providers/harnesses/compatibility), `fcitx5/`, `fontconfig/`, `keys/`, `lib/` (sourced helpers), `release` (cn release number) +- cn migrations live in `cn/migrations/*.sh`, run by `omarchy-cn-update` with per-file completion markers under `~/.local/state/omarchycn/` +- Packaging: `packages/omarchy-pkgs-cn.patch` must be applied to the sibling `omarchy-pkgs` checkout so `omarchy-dev` ships `cn/`; keyring in `packages/omarchycn-keyring/` +- Release process: `docs/release-checklist.md`; signing: `docs/release-signing.md`; pacman repo: `docs/pacman-repo.md` +- Upstream sync: `.gitea/workflows/upstream-sync.yml` opens a PR per upstream change; keep upstream file edits minimal (currently: one `GROUP_DESCRIPTIONS[cn]` line and the OmarchyCN menu section) +- cn tests: `test/shell.d/omarchycn-test.sh`, `test/shell.d/omarchycn-ai-test.sh` + # Documentation Layout Three documentation trees, split by genre and audience: - `agents/skills/` - task procedure ("do this when doing X"), for anyone working on the codebase - `docs/` - reference on how the system is shaped (file layout, update pipeline, theming, shell architecture), for anyone working on the codebase; skills link here for depth -- `manual/` - end-user documentation for using Omarchy, published; never codebase internals +- `manual/` - end-user documentation for using Omarchy, published; never codebase internals. Chinese user manual for the cn layer lives in `manual/zh-cn/` # Style