JARVIG documentation
designdoc.html at the repository root is the founding specification. These pages are the maintainable form of that document. They do not replace it.
The creator manual is manual/README.md. The rendered site is site/index.html. Rebuild it with pwsh -File scripts\build-docs.ps1. That site is a reader. It is not a second authority.
Authority
- Accepted ADRs in
adr/ - The pages in this tree
../designdoc.html- Accepted RFCs in
rfc/ - Source contracts and tests
- Notes and session reports
- Chat or model suggestions
Map
| Area | Start here |
|---|---|
| Creator manual | manual/README.md, getting-started.md |
| Current state | status/CURRENT.md |
| Tickets | BACKLOG.md |
| Milestones | ../ROADMAP.md |
| Architecture | architecture/overview.md |
| Platform | platform/overview.md |
| Rendering | rendering/overview.md |
| Materials | materials/overview.md |
| Assets | assets/asset-system.md |
| Simulation | physics/overview.md, animation/overview.md, ai/overview.md, audio/overview.md |
| Terrain | terrain/foundation.md, adr/ADR-0058-terrain-is-a-local-heightfield.md |
| Networking | networking/overview.md |
| Scripting and plugins | scripting/overview.md, plugins/overview.md |
| Build, profile, test | build/overview.md, profiling/overview.md, testing/overview.md |
| Hosts | hub/overview.md, editor/overview.md, cli/overview.md |
| Legal | legal/THIRD_PARTY.md |
| Decisions | adr/README.md |
| Research proposals | rfc/README.md, research/README.md |
| Benchmarks | benchmarks/README.md |
Founding sections
designdoc.html | Maintained page |
|---|---|
| 1 Charter, 2 Principles | architecture/overview.md |
| 3 License boundary | legal/THIRD_PARTY.md |
| 4 Topology, 5 Repository | ../ARCHITECTURE.md |
| 6 Runtime | architecture/engine-runtime.md |
| 7 World / coordinates | architecture/world.md, architecture/coordinate-frames.md |
| 8 ECS | architecture/ecs.md |
| 9 Editor / PIE | architecture/editor-runtime.md, architecture/play-in-editor.md |
| 10 Serialization | architecture/serialization.md |
| 11 Assets | assets/asset-system.md |
| 12 Renderer | rendering/overview.md |
| 12A Materials | materials/overview.md |
| 13 Virtual geometry | rendering/virtual-geometry.md, rfc/RFC-0001-virtual-geometry-baseline.md |
| 14–20 Simulation and net | subsystem overviews |
| 21–27 Platform and process | scripting, plugins, build, profiling, testing |
| 28–29 Milestones and slice | ../ROADMAP.md |
| 30 Agents | ../AGENTS.md |
| 32 ADR / RFC | adr/README.md, rfc/README.md |
| 33 Backlog | BACKLOG.md |