Skip to content

User Guide: 17-chapter comprehensive documentation #2

@ruvnet

Description

@ruvnet

Summary

Complete user guide covering all 13 RVM crates, from 5-minute quick start through advanced/exotic capabilities.

Contents (7,087 lines, 17 chapters)

  • 01-quickstart.md — Build, test, and boot in 5 minutes
  • 02-core-concepts.md — Partitions, capabilities, witnesses, proofs, coherence
  • 03-architecture.md — Layer diagram, data flow, boot sequence, feature flags
  • 04-crate-reference.md — All 13 crates with types, APIs, and dependencies
  • 05-capabilities-proofs.md — 7 rights, delegation trees, 3 proof tiers, TEE
  • 06-witness-audit.md — 64-byte records, hash chains, signing, querying
  • 07-partitions-scheduling.md — Lifecycle, IPC, split/merge, 2-signal scheduler
  • 08-memory-model.md — 4 tiers, buddy allocator, reconstruction pipeline
  • 09-wasm-agents.md — Module validation, 7-state lifecycle, migration
  • 10-security.md — 3-stage gate, attestation, audit results (11 findings)
  • 11-performance.md — 11 benchmarks, build profiles, tuning
  • 12-bare-metal.md — Linker script, QEMU, measured boot, Seed/Appliance
  • 13-advanced-exotic.md — 6 novel capabilities, fault rollback, RuVector
  • 14-troubleshooting.md — 12 categories of common issues
  • 15-glossary.md — 60+ terms with cross-references
  • cross-reference.md — Concept index, API finder, "I want to..." tasks

Features

  • Step-by-step, beginner-friendly language
  • Interconnected cross-references between all chapters
  • ASCII diagrams for architecture and data flow
  • Code examples from actual crate APIs
  • "See also" links at the end of every section

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions