Raven Scott
51b3b97bc0
Update onboarding, architecture diagrams, package docs, and glossary/FAQ language to keep trust boundaries and availability behavior consistent.
1.5 KiB
1.5 KiB
Documentation images
Diagrams in this repository are authored as Mermaid in the Markdown sources (handbook, user manual, developer guide, docs/) so they stay diff-friendly and render on Git hosts that support Mermaid.
Optional PNG / SVG assets may be added here for print, slides, or viewers without Mermaid. Reference them with a path relative to the Markdown file that embeds them.
Suggested assets (only if you commit binary figures):
| File | Intended content | Primary readers |
|---|---|---|
boot-flow.png |
Host → seeder (canonical) + optional booted helper → swarm → cold booter → MBR → drives → init.js → shell |
KERNEL_CONTRACT, architecture data flow |
two-drive-vfs.png |
System vs personal Hyperdrive and path routing ($HOME, /.bare/) |
User manual ch.1, VFS reference |
hyperswarm-protomux.png |
Topic discovery, replication channel bare-os-v1 |
Handbook ch.3 |
ctx-hierarchy.png |
ctx fields and capability wiring (simplified) |
Developer guide ch.2 |
identity-vault-lifecycle.png |
Guest → login → vault snapshot / logout | User manual ch.5 |
shell-pipeline.png |
Tokenize → expand → execute (pipelines, redirects) | Handbook ch.9, user manual ch.4 |
feature-bits-governance.png |
ADR 001 flow: doc ↔ code ↔ verifiers | Reference kernel-extensions, dev ADR |
Until such files exist, do not use  links to them in other docs — use Mermaid blocks instead (see Contributing to docs).