P1Start platform documentation¶

P1Start is an experimental OS / userspace stack (kernel, compositor, apps, and tooling) developed in this repository.

This site uses the same toolchain as Ubuntu Desktop documentation: Markdown, Sphinx, Canonical Sphinx, and Diátaxis.

Important

Canonical source-of-truth has moved to newdocs/ for active platform contracts.
Use newdocs/README.md and the linked subsystem docs for current behavior (init daemon set, settings control pattern, RegCube policy, networking/time/TLS contracts, and game-engine roadmap).
Treat this Sphinx tree as a curated reference/legacy layer unless a page explicitly states it is synchronized.

Important

Coverage is intentionally incomplete. Only a handful of deep engineering pages live in Sphinx today. For a row-by-row map of kernel modules, apps/* crates, SDK, build tooling - and what still exists only in code or in legacy HTML - open Documentation coverage matrix. That matrix is the backlog for making this site match the real project surface.

Note

Narrative guides and Rustdoc HTML under repository-root documentation/ predate this book. They are often more detailed per topic; see Legacy narrative documentation (documentation/) until each page is ported here.

In this documentation¶

Subsystem / coverage matrix (what exists vs what is missing): Documentation coverage matrix
Legacy HTML + rustdoc bundle (browse from disk): Legacy narrative documentation (documentation/)
Map of deep-dive docs: P1Start documentation index
Architecture: P1Start — system architecture (full stack)
Foundation ledger (IPC, WM present path, MM, client RGBA mmap vs brk): Foundation debt — stabilize before features
Terminal stack: Terminal stack — how it fits together
PIXEL (PXL) currency (design spec): PIXEL — P1START native currency (PXL)
Launch paths (dock, ramdisk): Launch paths — specification (dock, .lnk, ramdisk, builds)
Canonical contracts (full OS docs): Canonical Contracts

How this documentation is organized¶

We follow Diátaxis:

Tutorials — learning-oriented, step-by-step first contact with the platform.
How-to — task-oriented recipes (build, run in QEMU, pack an image, etc.).
Reference — specifications, roadmaps, and stable facts.
Explanation — understanding-oriented background (architecture, debt ledger, subsystems).