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

Docs Update

Browse Source
This commit is contained in:
Raven Scott
2026-04-04 19:51:05 -04:00
parent f8ddef7950
commit c29ec13cf9
47 changed files with 1106 additions and 464 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -3
View File
@@ -14,7 +14,9 @@ This project is **experimental research software**, not a production OS.
## Documentation
**On this page:** [User manual](#user-manual) · [Handbook](#handbook) · [Developer guide](#developer-guide) · [Reference and contracts](#reference-and-contracts) · [POSIX surface](#posix-surface)
**Start here:** [Documentation home](docs/README.md) — role-based map of every tree (user manual, handbook, developer guide, reference).
**On this page:** [User manual](#user-manual) · [Handbook](#handbook) · [Developer guide](#developer-guide) · [Reference and contracts](#reference-and-contracts) · [Glossary and help](#glossary-and-help) · [POSIX surface](#posix-surface)
### User manual
@@ -30,11 +32,18 @@ The [developer guide](developer-guide/README.md) is the **how-to** for `start(ct
### Reference and contracts
- **[Documentation hub](docs/README.md)** — links reference material, themes, and the Holepunch catalog.
- **[File-level reference](docs/reference/README.md)** — package paths, environment appendix, data-flow diagram (split from root [`DOCUMENTATION.md`](DOCUMENTATION.md)).
- **[Documentation hub](docs/README.md)** — full navigation map, themes, Holepunch catalog, ADRs, release checklist.
- **[File-level reference](docs/reference/README.md)** — package paths, environment appendix, data-flow diagram (legacy map: [`DOCUMENTATION.md`](DOCUMENTATION.md)).
- **[`ctx` API changelog](packages/bare-os-booter/CHANGELOG.md)** — **`bareOsCtxApiVersion`** history for kernels and scripts that depend on booter behavior.
- **[Compatibility matrix](docs/reference/compatibility-matrix.md)** — protocol, feature-bits doc, ctx API, and telemetry schema versions in one place.
### Glossary and help
- **[Glossary](docs/glossary.md)** — canonical definitions used across all trees.
- **[FAQ](docs/faq.md)** — cross-cutting questions with pointers to deep docs.
- **[Troubleshooting](docs/troubleshooting.md)** — symptom → doc router.
- **[Contributing to docs](docs/CONTRIBUTING-DOCS.md)** — style, Mermaid, link checks, terminology rules.
### POSIX surface
Intentional coverage and gaps for utilities, shell, and VFS: [handbook — Chapter 9](handbook/09-posix-utilities-shell-and-vfs.md).