Promote doctor check in onboarding docs

This commit is contained in:
Yeachan-Heo
2026-04-05 17:41:48 +00:00
parent af75a23be2
commit de758a52dd
2 changed files with 43 additions and 5 deletions

View File

@@ -31,7 +31,7 @@
</p>
> [!IMPORTANT]
> The active Rust workspace now lives in [`rust/`](./rust). Start with [`USAGE.md`](./USAGE.md) for build, auth, CLI, session, and parity-harness workflows, use [`rust/README.md`](./rust/README.md) for crate-level details, and see [`docs/container.md`](./docs/container.md) for Docker/Podman container-first usage.
> The active Rust workspace now lives in [`rust/`](./rust). Start with [`USAGE.md`](./USAGE.md) for build, auth, CLI, session, and parity-harness workflows, make the doctor health check your first run, use [`rust/README.md`](./rust/README.md) for crate-level details, and see [`docs/container.md`](./docs/container.md) for Docker/Podman container-first usage.
> Want the bigger idea behind this repo? Read [`PHILOSOPHY.md`](./PHILOSOPHY.md) and Sigrid Jin's public explanation: https://x.com/realsigridjin/status/2039472968624185713
@@ -57,6 +57,22 @@ https://x.com/realsigridjin/status/2039472968624185713
---
## New user onboarding
If you are here to try the Rust CLI, make the doctor check the first thing you run after building:
```bash
cd rust
cargo build --workspace
./target/debug/claw
# first command inside the REPL
/doctor
```
`/doctor` is the built-in setup and preflight diagnostic. After your first session, you can rerun the same health check with `./target/debug/claw --resume latest /doctor`.
For the rest of the install, auth, session, and parity-harness workflow, continue in [`USAGE.md`](./USAGE.md).
## Porting Status
The main source tree is now Python-first.
@@ -103,7 +119,7 @@ The new Python `src/` tree currently provides:
- **`query_engine.py`** — renders a Python porting summary from the active workspace
- **`main.py`** — a CLI entrypoint for manifest and summary output
## Quickstart
## Python workspace quickstart
Render the Python porting summary: