Skip to content

Commit 7c18c68

Browse files
committed
docs: add docs/ index + feature-status, drop replacement-audit
- Add docs/README.md as the docs landing page (linked from README). - Add docs/feature-status.md: capability matrix with code/test/doc evidence for every major surface, written from scratch without framing the project as a port of anything. - Remove docs/replacement-audit.md. - Point all README documentation links at docs/ instead of the wiki.
1 parent 63a4f65 commit 7c18c68

3 files changed

Lines changed: 47 additions & 31 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Agentic Harness isn't another AI SDK. It's a proper runtime-agnostic framework
1212
<img src="./assets/architecture.svg" alt="Agentic Harness architecture: a Rust agent compiled against the SDK, driven by the CLI and HTTP runtime, runnable on local checkouts, CI, remote sandboxes (Vercel/Daytona/E2B), or Cloudflare edge." width="880">
1313
</p>
1414

15-
> 📚 **Documentation lives in the [Wiki](https://github.com/codejunkie99/agentic-harness/wiki).**
16-
> Architecture, execution targets, runtime config, HTTP SessionEnv protocol, Cloudflare runtime, and release notes — all there.
15+
> 📚 **Documentation lives in [`docs/`](docs/).**
16+
> Architecture, execution targets, runtime config, HTTP SessionEnv protocol, Cloudflare runtime, feature status, and release notes — all there.
1717
1818
## Workspace
1919

@@ -345,7 +345,7 @@ agentic-harness build --workspace . --target node # alias — still emits
345345
agentic-harness build --workspace . --target cloudflare # Worker adapter + Durable Object bindings
346346
```
347347

348-
`--target cloudflare` produces non-proxy Worker boundary artifacts: `_entry.js`, `agentic_harness_worker.js`, `wrangler.jsonc`, and an adapter contract documented in `agentic_harness_app.d.ts`. See the [Cloudflare runtime guide](https://github.com/codejunkie99/agentic-harness/wiki/Cloudflare-Runtime) for the full pipeline (`--worker-app`, `--worker-wasm`, `--worker-wasm-crate`).
348+
`--target cloudflare` produces non-proxy Worker boundary artifacts: `_entry.js`, `agentic_harness_worker.js`, `wrangler.jsonc`, and an adapter contract documented in `agentic_harness_app.d.ts`. See [`docs/cloudflare-runtime.md`](docs/cloudflare-runtime.md) for the full pipeline (`--worker-app`, `--worker-wasm`, `--worker-wasm-crate`).
349349

350350
### Doctor, Smoke, Status
351351

@@ -366,15 +366,16 @@ agentic-harness dashboard --workspace . --json # status, templates, recent ru
366366

367367
## Documentation
368368

369-
Long-form docs live in the **[Wiki](https://github.com/codejunkie99/agentic-harness/wiki)**:
369+
Long-form docs live in [`docs/`](docs/):
370370

371-
- [Home](https://github.com/codejunkie99/agentic-harness/wiki) — start here
372-
- [Execution Targets](https://github.com/codejunkie99/agentic-harness/wiki/Execution-Targets) — local / CI / sandbox / Cloudflare split
373-
- [Runtime Config](https://github.com/codejunkie99/agentic-harness/wiki/Runtime-Config) — provider defaults, model registration
374-
- [HTTP SessionEnv Protocol](https://github.com/codejunkie99/agentic-harness/wiki/HTTP-Session-Env) — exact wire format for remote sandboxes
375-
- [Cloudflare Runtime](https://github.com/codejunkie99/agentic-harness/wiki/Cloudflare-Runtime) — Worker boundary build, Durable Objects, adapter ABI
376-
- [Feature Status](https://github.com/codejunkie99/agentic-harness/wiki/Feature-Status) — what's shipped, what's next
377-
- [Release Smoke Test](https://github.com/codejunkie99/agentic-harness/wiki/Release-Smoke-Test) — clean-machine pre-publish checklist
371+
- [Docs index](docs/README.md) — start here
372+
- [Execution Targets](docs/execution-targets.md) — local / CI / sandbox / Cloudflare split
373+
- [Runtime Config](docs/runtime-config.md) — provider defaults, model registration
374+
- [HTTP SessionEnv Protocol](docs/http-session-env.md) — exact wire format for remote sandboxes
375+
- [Cloudflare Runtime](docs/cloudflare-runtime.md) — Worker boundary build, Durable Objects, adapter ABI
376+
- [Feature Status](docs/feature-status.md) — what's shipped, with code/test/doc evidence
377+
- [Roadmap](docs/immediate-goals.md) — the next product slice and explicit non-goals
378+
- [Release Smoke Test](docs/release-smoke-test.md) — clean-machine pre-publish checklist
378379

379380
## Development
380381

docs/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Agentic Harness Docs
2+
3+
Long-form documentation for [Agentic Harness](../README.md). For overview, install, and runnable examples, see the top-level [README](../README.md). This folder covers architecture, protocols, and operational concerns that don't fit on the front page.
4+
5+
## Architecture
6+
7+
- **[Execution Targets](execution-targets.md)** — local development, CI, remote Linux sandboxes (Vercel Sandbox, Daytona, E2B), and Cloudflare edge — what runs where, and why.
8+
- **[Runtime Config](runtime-config.md)** — provider defaults, env-key resolution, OpenAI-compatible model registration, role/call/default precedence, and `runtime.json` discovery rules.
9+
- **[HTTP SessionEnv Protocol](http-session-env.md)** — the JSON-over-HTTP wire format that lets a Rust agent run shell, file, and env operations inside any remote sandbox that speaks the protocol.
10+
- **[Cloudflare Runtime](cloudflare-runtime.md)** — Worker boundary build pipeline, Durable Object bindings, the WASM JSON ABI, and the `--worker-app` / `--worker-wasm` / `--worker-wasm-crate` build options.
11+
12+
## Status & Releases
13+
14+
- **[Feature Status](feature-status.md)** — capability matrix with code, tests, and docs evidence for every major surface.
15+
- **[Roadmap](immediate-goals.md)** — the next product slice and explicit non-goals.
16+
- **[Release Smoke Test](release-smoke-test.md)** — clean-machine pre-publish checklist (`smoke --json`, `release-check --json`, install script, Homebrew formula, changelog).

0 commit comments

Comments
 (0)