docs: add per-crate READMEs and bump to 0.3.8#4
Merged
Conversation
Add a README.md to every workspace crate (7 core crates + 5 adapters), each documenting the crate's role, public API, a usage example, workspace placement, status, and links to the ADRs/DDD contexts it realizes — matching the style of apps/el-chat/README.md. Bump the workspace version 0.3.7 -> 0.3.8 via `cargo set-version --workspace` (docs-only change; el-chat inherits, the excluded el-grammar-llguidance is unaffected). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ayout - Add an "Architecture and entry points" section: a three-layer table (el-ffi/EdgeLlm device facade → el-core/LlmProvider seam → el-runtime orchestrator) and a layered diagram, making the SDK entry point explicit. - Restructure long sections into collapsible <details> blocks with a Contents TOC for readability (Why, decode pipeline, quick-start extras, chat client, workspace map, ADRs, domain model, roadmap). - Fix the stale "workspace-excluded" label on the el-ffi row — el-ffi and el-cloud are regular workspace members; only el-grammar-llguidance is excluded. Link each crate to its new per-crate README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
README.mdto every crate in the workspace and bumps the workspace version0.3.7 → 0.3.8(docs-only patch).Each README follows the style of
apps/el-chat/README.md: a role summary, a public-API table, an accurate Rust usage example, workspace placement, status, and relative links to the ADRs / DDD bounded contexts the crate realizes.Core crates (
crates/)LoadPermitas an unforgeable capability (ADR-006)grammar → safety → sample → commitdecode invariant (ADR-001/004)Adapters (
crates/adapters/)EL_BENCH), el-cloud, el-grammar-llguidance (standalone build), el-ffi (RN/Flutter/Web + Makefile targets)Version bump
cargo set-version --workspace 0.3.8— updates[workspace.package]and every[workspace.dependencies]entry;el-chatinherits viaversion.workspace = true; the excluded standaloneel-grammar-llguidance(0.1.0) is untouched.Cargo.lockregenerated.Note on a stale claim corrected here
el-cloud/el-ffisource comments and the root README's workspace map describe these as workspace-excluded, butcargo metadataconfirms both are real members — onlyel-grammar-llguidanceis excluded. The new READMEs describe the actual build (cloud egress is opt-in atCloudProviderconstruction + non-wasm32 dep gating, not by build exclusion). Cleaning up those stale source/README comments is left as a follow-up.Out of scope
The pre-existing
.gitignorechange and untrackedbenchmarks/directory are unrelated and intentionally left out of this PR.🤖 Generated with Claude Code