Skip to content

Docs/restructure all docs#10

Merged
zevorn merged 3 commits intomainfrom
docs/restructure-all-docs
Mar 15, 2026
Merged

Docs/restructure all docs#10
zevorn merged 3 commits intomainfrom
docs/restructure-all-docs

Conversation

@zevorn
Copy link
Copy Markdown
Owner

@zevorn zevorn commented Mar 15, 2026

No description provided.

zevorn added 3 commits March 15, 2026 10:05
- Swarm Intelligence: In Progress → Done
- Skill Memory → Skills (renamed): In Progress → Done
- Add Web Flash & Serial feature (Done)
- ESP32-C3 real hardware: Untested → Verified (xiaozhi-xmini)
- Architecture: add driver layer, tools on drivers, skills above tools

Signed-off-by: Chao Liu <chao.liu.zevorn@gmail.com>
Remove redundant docs and create focused, non-overlapping documents:

Deleted (content merged into new docs or already in README):
- rt-claw-intro.md (en/zh) — 95% overlap with README
- design.md (en/zh) — roadmap content, merged into architecture
- esp32c3-qemu.md (en/zh) — merged into getting-started

Rewritten:
- architecture.md (en/zh) — focused on OSAL, services, drivers,
  build flow, priority model, resource budget

New documents:
- getting-started.md (en/zh) — unified build/flash/run guide for
  all platforms: ESP32-C3/S3 QEMU and hardware, vexpress-a9
- usage.md (en/zh) — shell commands, 24 Tool Use tools, skill
  system, conversation memory, Feishu integration
- porting.md (en/zh) — porting to new platforms, adding tools,
  skills, and drivers with code examples
- tuning.md (en/zh) — module trimming, memory optimization,
  configuration reference, profile examples

Updated:
- README.md / README_zh.md — navigation links and doc section

Final structure: 7 docs x 2 languages = 14 files, ~2400 lines.

Signed-off-by: Chao Liu <chao.liu.zevorn@gmail.com>
Two lines were 63 chars instead of 64, breaking the box border.

Signed-off-by: Chao Liu <chao.liu.zevorn@gmail.com>
@zevorn zevorn merged commit 246c015 into main Mar 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant