aslice documentation

Back to the project overview.

aslice is in the design phase; there is no release to install yet. These documents describe the intended system. Implementation and platform validation remain work to be done.

Document catalog

Guides and vocabulary

Document	Purpose
Manual	User workflows for installing, running, and managing software.
Developing	Development entrypoint, code boundaries, simulator application, packaging, and tests.
Authoring	Writing, testing, and shipping packages.
Nomenclature	Project terms, acronyms, and their Homebrew equivalents.

Architecture and contracts

Document	Purpose
Design	Platform scope, architecture, security model, and roadmap.
State and recovery	Artifact identity, privilege boundaries, transactions, replay, and acceptance gates.
Database	Six SQLite roles, executable schemas, durable records, inspection, backup, and disaster recovery.
Slice format	Binary archive layout, manifests, verification, and extraction limits.
Package format	Package definitions, dependency and version semantics, lock files, and the build API.
Setup	Declarative machine configuration and the semantics of applying, exporting, and importing it.
Helpers	Client process roles, privileged operations, runtime shims, and package services.
System volumes	Protected-volume patching, Recovery procedures, boot snapshots, and undo.

Build and operations

Document	Purpose
Build infrastructure	The shared local and farm build harness, scheduling, worker trust, testing, and publication.
Toolchain	The compiler bundle, build integration, bootstrap, and version updates.
Repositories	Official sources, third-party repositories, trust levels, and signing.
Orchard policy	Package acceptance, variants, maintenance, review gates, and release policy.

Runbooks

See the runbooks index for reading guidance and procedure status.

Document	Purpose
Genesis	Bringing the project into existence and rebuilding it after a total loss.
Key runbook	Signing-key setup, rotation, recovery, and drills.

Supporting resources

GitHub Pages portal tooling — static documentation, archive reader, local preview, and publishing checks.
Command manuals — command syntax, options, examples, and exit statuses.
Machine-readable schematics — schemas and examples for data contracts.
Reference archive — locally preserved sources and their catalog.
Contributing guidelines — contribution workflow and checks.
Repository structure — where content belongs and the planned C++ layout.
Security policy — reporting vulnerabilities and the project's security boundaries.

Source document