snxraven/bare-operating-system
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update Docs

Browse Source
This commit is contained in:
Raven Scott
2026-04-06 06:44:15 -04:00
parent 6d0d1b8049
commit f0fb05274b
21 changed files with 573 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DOCUMENTATION.md
+20 -2
View File
@@ -1,8 +1,24 @@
# Documentation
Start at the **[documentation home](docs/README.md)** for role-based navigation (run, understand, extend, specify), **time-boxed paths** (“Pick your depth”), and the **POSIX + P2P** dashboard. Short evergreen explainers live under **[docs/concepts/](docs/concepts/README.md)** (two drives, boot timeline, swarm, identity, POSIX stance).
**Start here:** **[documentation home](docs/README.md)** — role-based navigation (run, understand, extend, specify), time-boxed paths, POSIX + P2P dashboard, and contract bump checklist.
This file keeps a **legacy map** from the former single-file inventory to the split reference topics below.
**First run:** **[Get started](docs/get-started.md)** — clone, prerequisites, two terminals, success checks, and a short failure table.
**Orientation:** **[Documentation sitemap](docs/sitemap.md)** — how the user manual, handbook, developer guide, reference, and concepts folders relate.
Short evergreen explainers: **[docs/concepts/](docs/concepts/README.md)** (two drives, boot timeline, swarm, identity, POSIX stance).
Below, a **comparison frame** (not a security claim); deeper limits are in the [handbook preface](handbook/00-preface.md).
| | Bare OS | Classic OS image | Container on a host |
| --- | --- | --- | --- |
| **Distribution** | P2P Hyperdrive + swarm | ISO / image mirror | Registry pull |
| **Mutable user state** | Personal Hyperdrive | Local disk | Writable layers / volumes |
| **Guest execution** | `ctx` + VFS over drives | Kernel + real HW/VM | Namespaces + host kernel |
| **POSIX** | Declared profile + facade | Full kernel | Often libc + syscall pass-through |
| **Isolation / threat model** | Single host process; no hardware sandbox | VM / ring boundaries vary | Host kernel + namespaces |
This file also keeps a **legacy map** from the former single-file inventory to the split reference topics.
> **Note**
> Canonical **terminology**: [docs/glossary.md](docs/glossary.md). **FAQ** and **troubleshooting router**: [docs/faq.md](docs/faq.md), [docs/troubleshooting.md](docs/troubleshooting.md).
@@ -13,7 +29,9 @@ This file keeps a **legacy map** from the former single-file inventory to the sp
| Goal | Link |
| --- | --- |
| Zero-to-prompt (new clone) | [docs/get-started.md](docs/get-started.md) |
| Documentation hub (full map, curricula) | [docs/README.md](docs/README.md) |
| Doc trees at a glance | [docs/sitemap.md](docs/sitemap.md) |
| Evergreen concepts (two drives, boot, P2P) | [docs/concepts/README.md](docs/concepts/README.md) |
| Run the system | [users-manual/README.md](users-manual/README.md) |
| Architecture narrative | [handbook/README.md](handbook/README.md) |