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:17:03 -04:00
parent df238108d2
commit 140b17c5fd
9 changed files with 95 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/images/README.md
+10 -14
View File
@@ -1,23 +1,19 @@
# Documentation images (placeholders)
# Documentation images
High-resolution or branded figures can live here. **Mermaid** diagrams in Markdown remain the default so diagrams stay diff-friendly.
**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.
When you add an asset, reference it from the relevant doc using a path **relative to that file**, for example from `handbook/02-blueprints.md`:
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.
```markdown
![Boot path from seeder to shell](../docs/images/boot-flow.png)
```
Suggested assets (titles are indicative):
Suggested assets (only if you commit binary figures):
| File | Intended content | Primary readers |
| --- | --- | --- |
| `boot-flow.png` | Host → seeder swarm → booter → MBR → drives → `init.js` → shell | User manual, handbook ch.2–3 |
| `two-drive-vfs.png` | System vs personal Hyperdrive and path routing (`$HOME`, `/.bare/`) | Handbook ch.2, reference VFS |
| `hyperswarm-protomux.png` | Topic discovery, replication channel `bare-os-v1` | Handbook ch.3, protocol reference |
| `boot-flow.png` | Host → seeder → swarm → 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 | Handbook ch.5, user manual |
| `shell-pipeline.png` | Tokenize → expand → execute (pipelines, redirects) | Handbook ch.9 |
| `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 files exist, narrative pages may include `![alt text](...)` placeholders with a short caption explaining the intended graphic.
Until such files exist, **do not** use `![alt](...)` links to them in other docs — use Mermaid blocks instead (see [Contributing to docs](../CONTRIBUTING-DOCS.md)).