ed41f366dc
- build one backend-neutral host per platform and package native runtimes separately - compose immutable product-v2 bundles from verified host and runtime artifacts - enforce host import policy and runtime provenance across release and SDK lanes - align debug, release, Windows, Kotlin, and Swift validation with the composed product model - update release documentation, CI topology, and agent guidance for the unified path - require no-device client readiness and bounded clean shutdown for packaged runtimes
4.9 KiB
Documentation
Use this hub to find project guides that are not owned by a single Rust crate.
Start here
| Need | Doc |
|---|---|
| Install, run, service mode, model storage | USAGE.md |
| Private meshes, published meshes, public joining | MESHES.md |
| Local routing reputation and target cooldowns | NODE_REP.md |
| SDK usage, examples, errors, lifecycle, platform support | SDK.md |
| Language-specific SDK examples | Rust, Node.js, Swift, Kotlin/Android |
| Run big models with Skippy layer splits | SKIPPY_SPLITS.md |
| Contribute or publish layer package repositories | LAYER_PACKAGE_REPOS.md |
| Goose, Claude Code, OpenCode, Pi, curl, blackboard | AGENTS.md |
| Command-by-command CLI reference | CLI.md |
| Exo comparison | EXO_COMPARISON.md |
Skippy and model-package docs
| Doc | What it covers |
|---|---|
| skippy/FAMILY_STATUS.md | Certified family/split/wire-dtype status |
| skippy/NEW_MODEL_ONBOARDING.md | New-model split/certification intake checklist |
| skippy/FAMILY_CERTIFY.md | Certification workflow for new families |
| skippy/TOPOLOGY_PLANNER.md | Stage topology planning behavior |
| skippy/CONFIGURATION.md | Authoritative operator matrix for Skippy config keys and rejection boundaries |
| skippy/PROMPT_CACHE.md | OpenAI prompt-prefix cache behavior, defaults, telemetry, and benchmark flow |
| skippy/PIPELINED_VERIFY_WINDOW.md | Native MTP, anchored N-gram extension, VerifyWindow protocol, pipeline behavior, and telemetry |
| skippy/SUFFIX_NGRAM_PROPOSER.md | Long exact-suffix proposer design, invariants, telemetry, and benchmark contract |
| skippy/DATA_FLOW.md | Stage data flow and transport details |
| skippy/LLAMA_PARITY.md | Remaining llama.cpp parity queue |
| specs/layer-package-repos.md | Manifest schema and package artifact rules |
| specs/mesh-setup-installer.md | Bootstrap installer and mesh-llm setup ownership boundary |
| SKIPPY.md | Skippy integration readiness and parity notes |
Use SKIPPY_SPLITS.md for Skippy split-serving workflows.
Other references
| Doc or directory | What belongs there |
|---|---|
| BENCHMARKS.md | Current benchmark numbers and performance context |
| SWARM_CAPTURE.md | Opt-in local debug capture for mesh membership and connection diagnostics |
| design/ | Architecture notes, protocol design, testing playbooks, carried llama.cpp patch documentation |
| design/NATIVE_RUNTIMES.md | Native runtime artifact packaging, exact version matching, resolver behavior, and SDK/autoupdater ownership |
| design/NODE_OWNER_IDENTITY.md | Owner identity, trust policy, and how owner trust stays separate from release attestation |
| design/EMITTER_HOOKS.md | Inventory of hook, callback, and emitter surfaces plus readiness ownership. |
| plugins/ | Plugin architecture, web UI projection contract, exemplars, and implementation planning |
| plans/ | Narrow implementation plans that are not yet general design docs |
| specs/ | Focused behavior specs for individual features |
| design/OPENAI_GUARDRAILS.md | OpenAI guardrail rollout defaults, v1 limits, telemetry privacy, and evidence scaffolding |
Per-crate docs stay with their crates. The main binary crate overview lives at ../crates/mesh-llm/README.md, and the web console/embedded asset crate overview lives at ../crates/mesh-llm-ui/README.md. Shared protocol-facing model/type ownership lives at ../crates/mesh-llm-types/README.md. Shared owner identity and envelope crypto lives at ../crates/mesh-llm-identity/README.md. Shared wire protocol ownership lives at ../crates/mesh-llm-protocol/README.md. Shared routing target ownership lives at ../crates/mesh-llm-routing/README.md.
Developers migrating from backend-linked release commands should use the host/runtime/product commands in design/NATIVE_RUNTIMES.md. Installed and portable products keep their selected runtime beside the neutral host or in the documented package-owned directory, with the user cache only as a fallback.