From 0b5dffb9da784e8c82efc70b8631f77a3c67e5ad Mon Sep 17 00:00:00 2001 From: YeonGyu-Kim Date: Wed, 22 Apr 2026 20:49:09 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20README.md=20=E2=80=94=20promote=20ERROR?= =?UTF-8?q?=5FHANDLING.md=20to=20first-class=20navigation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cycle #23 ships a documentation discoverability fix. After #22 shipping ERROR_HANDLING.md, the next natural step is making it discoverable from the project's entry point (README.md). Before: README top navigation linked to USAGE, PARITY, ROADMAP, Rust workspace. ERROR_HANDLING.md was buried in CLAUDE.md references. After: ERROR_HANDLING.md is now in the top navigation (right after USAGE, before Rust workspace). Also added SCHEMAS.md mention in repository shape. This signals that: 1. Error handling is a first-class concern (not an afterthought) 2. The Python harness documentation (SCHEMAS.md, ERROR_HANDLING.md, CLAUDE.md) is part of the official docs, not just dogfood artifacts 3. New users/claws can discover the error-handling pattern at entry point Impact: Operators building orchestration code will immediately see 'Error Handling' link in navigation, shortening the path to understanding how to consume the protocol reliably. No code changes. No test changes. Pure navigation/discoverability. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0b09007..c51eaf8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ · Usage · + Error Handling + · Rust workspace · Parity @@ -40,9 +42,11 @@ The canonical implementation lives in [`rust/`](./rust), and the current source - **`rust/`** — canonical Rust workspace and the `claw` CLI binary - **`USAGE.md`** — task-oriented usage guide for the current product surface +- **`ERROR_HANDLING.md`** — unified error-handling pattern for orchestration code - **`PARITY.md`** — Rust-port parity status and migration notes - **`ROADMAP.md`** — active roadmap and cleanup backlog - **`PHILOSOPHY.md`** — project intent and system-design framing +- **`SCHEMAS.md`** — JSON protocol contract (Python harness reference) - **`src/` + `tests/`** — companion Python/reference workspace and audit helpers; not the primary runtime surface ## Quick start