docs: document 0.1.0 crate release

This commit is contained in:
2026-10-02 19:46:08 +09:00
parent 193ca89d93
commit da559de912
9 changed files with 250 additions and 20 deletions
+42 -20
View File
@@ -13,29 +13,36 @@ repository root is not itself a package.
## Crate graph and responsibilities
```text
wip-tui (interactive Worldspace explorer and operation editor)
├── wip-client Known Space, request identity, validators, and calls
├── wip-http framework-neutral HTTP request/response messages
└── wip-protocol descriptors and logical values
Published libraries
wip-fs-server (request-time filesystem projection and loopback listener)
├── wip-http standard routes/codecs/envelopes
├── wip-host request-scoped publication and dispatch
└── wip-interface macro-generated filesystem capabilities
wip-client
├── wip-http
│ └── wip-protocol
└── wip-protocol
wip-public-api-example (workspace-only executable, integration tests, doctest)
├── wip-protocol logical declarations, values, calls, and validation
├── wip-http standard HTTP v1 routes, JSON codecs, and envelopes
wip-host
├── wip-interface
│ ├── wip-interface-macros
│ └── wip-protocol
├── wip-client stateful Known Space, lazy tree, observation, and call runtime
│ ├── wip-http
│ └── wip-protocol
├── wip-interface application DTO codecs and interface authoring facade
│ ├── wip-protocol
│ └── wip-interface-macros proc-macro implementation detail
└── wip-host descriptor registry, publication, and qualified dispatch
├── wip-interface
└── wip-protocol
└── wip-protocol
Workspace-only applications and conformance consumers
wip-tui
├── wip-client
├── wip-http
└── wip-protocol
wip-fs-server
├── wip-host
├── wip-http
├── wip-interface
└── wip-protocol
wip-public-api-example
├── wip-host
├── wip-interface
└── wip-protocol
```
| Crate | Responsibility | Does not own |
@@ -50,6 +57,21 @@ wip-public-api-example (workspace-only executable, integration tests, doctest)
| `wip-fs-server` | Linux directory-handle-confined request-time projection, complete depth-bounded observations and bounded file operations, standard `wip-http` dispatch, and a loopback HTTP binary. | A new wire profile, implicit symlink following, non-loopback cleartext, authentication policy, TLS termination, or filesystem-wide preregistration. |
| `wip-public-api-example` | An independently compiled consumer of the protocol, authoring, and host public crates. Its DTOs and traits are application-owned; its implementation and backend handle remain host-private. | Reusable library API or a production server. |
## Published crates
The `0.1.0` release consists of these six crates:
- `wip-protocol`
- `wip-interface-macros` — implementation dependency re-exported by `wip-interface`
- `wip-interface`
- `wip-host`
- `wip-http`
- `wip-client`
The filesystem server, terminal client, and public-API example are workspace-only packages and set `publish = false`. All workspace packages require Rust 1.88 or newer and are licensed under either Apache-2.0 or MIT at your option.
See [RELEASING.md](RELEASING.md) for the dependency-ordered crates.io procedure and [CHANGELOG.md](CHANGELOG.md) for release contents.
The boundary is intentional: protocol types describe what can cross a
transport; application DTOs opt into that model with `WipType`; a host-private
implementation owns credentials, handles, and backend state; and `wip-http`