README.md

LayerFS documentation

Status: Current documentation entry point; v0.1.7 release documentation.

LayerFS 1.1.0 (release candidate)

• Release record, compatibility and the owner waiver
• JavaScript packages wiki and its how-to guides

Use LayerFS v0.1.7

• Manual
• SDK and terminal UI guide
• SDK reference
• Release record, compatibility and waivers
• Next: LayerFS 1.0.0 plan (archived; see removed roadmap)

Historical LayerFS 0.1.6

• Manual
• Quickstart
• CLI reference
• Rust SDK reference
• Container runtime
• Release record and accepted limitations
• Owner acceptance, waivers and issue disposition
• Sandbox-local state and unchanged Store format
• Honest limitations
• Every measured v0.1.6 selection

Historical LayerFS 0.1.5

• Manual
• Release record
• Every v0.1.5 benchmark family and case

Historical LayerFS 0.1.4

• Manual
• Release record
• Every v0.1.4 benchmark family and case

Historical LayerFS 0.1.3

• Manual
• Quickstart
• Product specification
• CLI reference
• Rust SDK reference
• Container runtime
• Storage format
• Limitations
• Release record

Plan and build

• Roadmap, 0.1.1 history, 0.1.3 completed checkpoint and 0.1.x development: archived, see removed roadmap
• Complete cluster-two implementation plan: current S7–S13 ordering, iterative exits, optimization decisions, FUSE experiment readiness and expected source structure
• Cluster-two performance acceptance: existing numerical gates, required work/resource bounds, prospective registration and retained failures
• Historical S7–S9 continuation prompt: retained source and stopping-boundary context; use the complete plan for current remaining-work ordering
• Core concepts
• Sandbox cache design: cluster-two ownership, branch sharing, source structure and remaining qualification
• Workspace filesystem view: global Store base, daemon overlay, lazy FUSE read path and ASCII diagrams
• Workspace queue scheduling: archived; the shared-database queue and credits removed by #321
• Optimization guide: binding performance-engineering rules
• Optimization handbook: diagnostic groups, existing counters, scaling checks, procedure and the current candidate list
• Benchmark rules
• Benchmark instruction: the optimization iteration and its metrics
• Release policy
• Documentation policy
• Development workspace cleanup: ownership checks, verified recovery, evidence retention, and disk-space reporting
• Parallel worktree development: private Cargo resources, prepared dependencies, pinned SDK builds, and per-run Docker E2E state
• Plugin listings: how a plugin built on LayerFS is listed in plugins/<plugin-id>/, with the template to copy and the checker

Explore

• Research and historical design material

The directory classes are deliberately small:

versioned/    immutable released manuals
general/      version-independent concepts and policies
plugins/      the plugin listing guide, its template and checker
research/     informative studies and historical design material
assets/       images used by maintained documentation

Release announcements, proof, artifacts, limitations, and performance evidence remain under docs/release-notes/.

Removed roadmap and raw evidence

Issue #398 (2026-10-22) removed from main, to cut the checkout size:

• all of docs/roadmap/ (plans, release checklists, proposals, development guides, dated checkpoints and the 0.1.x evidence campaigns);
• raw run output (.json, .jsonl, .stderr, .stdout, .log, .txt, .csv, .tsv, .gz, .sqlite) under core/docs/issues/, core/docs/architecture/proposal/ and core/docs/api/evidence/. Their .md records, scripts, patches and checksum files remain. Issue #352's records and the three files benchmark/fs-bench-pro reads were kept.

Nothing was rewritten in history. Every removed file is at commit 792715f00a, also tagged docs-raw-sqlite-final. Older documents that link into the removed paths resolve there. To restore a file or directory locally:

git restore --source=792715f00a -- <path>