chore: relocate shater meta-docs to docs-shater/ (avoid upstream docs/ collision)

Upstream sing-box-lx already ships a docs/ mkdocs site; keep our project docs
separate and unambiguous in docs-shater/ (parallels upstream's docs-lx/).
Updated all references in README.md, CLAUDE.md, CONTEXT.md, ARCHITECTURE.md.
This commit is contained in:
2026-07-14 14:19:34 +03:00
parent 2c7b1ff9d8
commit d41a685d9b
8 changed files with 15 additions and 15 deletions
+3 -3
View File
@@ -42,21 +42,21 @@
Дизайн-направление ЗАФИКСИРОВАНО: **Faceplate** (панель сетевого железа).
Полная спека, токены, компоненты и ссылка на живой эталон — в
[`docs/DESIGN.md`](docs/DESIGN.md). Эталон:
[`docs-shater/DESIGN.md`](docs-shater/DESIGN.md). Эталон:
https://claude.ai/code/artifact/9f7c07e8-d8ac-4ae1-b113-5b25d0ba5dd2
- **Стек:** Vite + React + TypeScript, лёгкий (SPA встраивается в бинарь —
без тяжёлых зависимостей). Расположение: папка `panel/` в корне.
- **Порядок работ:**
1. Сам (оркестратор) скаффолдишь `panel/`, переносишь токены из
`docs/DESIGN.md` в `panel/src/tokens.css` один-в-один и задаёшь каркас
`docs-shater/DESIGN.md` в `panel/src/tokens.css` один-в-один и задаёшь каркас
компонентов. Это фундамент — делай аккуратно сам или отдай ОДНОМУ агенту.
2. Дизайн-систему в компоненты: `<Faceplate> <Module> <Toggle> <Led>
<SegMeter> <QueryLog>` + кнопки — строго по эталону.
3. Страницы раздаёшь ПАРАЛЛЕЛЬНО Opus-агентам (`model: "opus"`), по одной на
агента: Overview, Nodes/Subscriptions, Routing rules, DNS/Blocklists,
Devices, Apply/Rollback.
- **В КАЖДОМ ТЗ агенту обязательно:** ссылка на `docs/DESIGN.md` и на эталон;
- **В КАЖДОМ ТЗ агенту обязательно:** ссылка на `docs-shater/DESIGN.md` и на эталон;
требование сначала вызвать Skill `react-expert` и Skill
`frontend-design:frontend-design` и следовать им; список готовых компонентов,
которые он ДОЛЖЕН переиспользовать (не изобретать заново); какие токены и
+9 -9
View File
@@ -41,24 +41,24 @@ own.
- Fail-closed kill-switch, atomic apply with commit-confirm rollback, signed opkg
feed.
See **[`docs/FEATURES.md`](docs/FEATURES.md)** for the full list.
See **[`docs-shater/FEATURES.md`](docs-shater/FEATURES.md)** for the full list.
## Documentation
| Doc | What |
|-----|------|
| [`docs/CONTEXT.md`](docs/CONTEXT.md) | **Start here** — project context, v0.1→v0.2 history, decisions in brief, testbed/infra |
| [`docs/ROADMAP.md`](docs/ROADMAP.md) | Phased plan (Phase 1 = fork + embedding prototype) |
| [`docs/FEATURES.md`](docs/FEATURES.md) | Full feature list with MVP/T1/T2 tags |
| [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) | One-binary design, auth handoff, data/DNS/apply flow (diagrams) |
| [`docs/DECISIONS.md`](docs/DECISIONS.md) | Why sing-box, why fork, why the panel split, license, etc. |
| [`docs/DESIGN.md`](docs/DESIGN.md) | Admin-panel visual system — the "Faceplate" direction, tokens, components, north-star prototype |
| [`docs-shater/CONTEXT.md`](docs-shater/CONTEXT.md) | **Start here** — project context, v0.1→v0.2 history, decisions in brief, testbed/infra |
| [`docs-shater/ROADMAP.md`](docs-shater/ROADMAP.md) | Phased plan (Phase 1 = fork + embedding prototype) |
| [`docs-shater/FEATURES.md`](docs-shater/FEATURES.md) | Full feature list with MVP/T1/T2 tags |
| [`docs-shater/ARCHITECTURE.md`](docs-shater/ARCHITECTURE.md) | One-binary design, auth handoff, data/DNS/apply flow (diagrams) |
| [`docs-shater/DECISIONS.md`](docs-shater/DECISIONS.md) | Why sing-box, why fork, why the panel split, license, etc. |
| [`docs-shater/DESIGN.md`](docs-shater/DESIGN.md) | Admin-panel visual system — the "Faceplate" direction, tokens, components, north-star prototype |
## Status
Foundation reset complete: v0.1 preserved on its branch, `main` reset for v0.2.
Next is **Phase 1** — fork sing-box-lx into `main` and stand up the embedding
prototype (prove AmneziaWG 2.0, measure binary size). Follow `docs/ROADMAP.md`.
prototype (prove AmneziaWG 2.0, measure binary size). Follow `docs-shater/ROADMAP.md`.
## Hardware
@@ -68,4 +68,4 @@ QEMU test VM.
## License
[GPL-3.0](LICENSE) (sing-box is GPL-3.0). See `docs/DECISIONS.md` D6.
[GPL-3.0](LICENSE) (sing-box is GPL-3.0). See `docs-shater/DECISIONS.md` D6.
@@ -34,7 +34,7 @@ flowchart TB
Overlay dirs (added on top of the upstream sing-box-lx tree, conflict-free):
`shater/` (Go: control-plane, DNS filter, stats, engine host), `panel/` (admin
SPA + its Go server), `openwrt/` (LuCI thin app, procd/shater-core, Makefiles,
feed/CI), `docs/`.
feed/CI), `docs-shater/`.
## 2. Auth handoff — LuCI → admin panel
+2 -2
View File
@@ -87,11 +87,11 @@ We are rebasing onto a new engine and a new UI architecture. Full rationale in
- **`shater` `main` = our fork of sing-box-lx.** After Phase 1 it contains the
full sing-box-lx tree PLUS our additive overlay (`shater/`, `panel/`,
`openwrt/`, `docs/`). Upstream is tracked via a git remote and merged by tag.
`openwrt/`, `docs-shater/`). Upstream is tracked via a git remote and merged by tag.
- **`shater` branch `v0.1`** = the standalone xray-based version (frozen, ported
from).
- Until Phase 1 merges the engine in, `main` is the docs-first overlay seed you
are reading now (LICENSE, README, `docs/`, `dist/shater-feed.pub`).
are reading now (LICENSE, README, `docs-shater/`, `dist/shater-feed.pub`).
## What to port from v0.1 (don't rewrite these ideas)