Files
LithosAnanake/docs/README.md
T

51 lines
2.8 KiB
Markdown

# StarForth / LithosAnanke Documentation
This is the `lithosananke` branch: the bare-metal StarKernel side of the project
(contrast `master`, which is the hosted-VM-only side). Documentation follows the
two-tier model described in `docs/CLAUDE.md`: **`formal/`** is the polished,
citable LaTeX tier; **`working/`** is living design notes and drafts that feed it.
Everything else in this directory is branch- or subsystem-specific material that
doesn't fit either tier.
## Layout
- **[formal/](formal/)** — Three-volume LaTeX documentation set (research volumes,
practitioner books, standalone reports) plus the `scraps/` fragment library it's
assembled from. Audience: patent counsel, SSRN reviewers, licensees, hobbyists
with hardware in hand. See `formal/CLAUDE.md` for authoring conventions.
- **[working/](working/)** — Living documents: architecture design notes, DoE
experiment logs, hardware/platform notes, draft specs, academic-paper source
material, and an archive of superseded docs. Source material for `formal/`.
- **[03-architecture/](03-architecture/)** — Tripod VM architecture constraints
(Hera/Hermes/Artemis) and the word-level ACL system design.
- **[lithosananke/](lithosananke/)** — LithosAnanke kernel branch documentation:
milestone roadmap, system architecture, HAL reference, kernel command-line
argument design, and the amd64 APIC-timer ISR postmortem.
- **[birthing/](birthing/)** — VM birthing plan and status for the Hera-spawns-
Hermes/Artemis constellation, plus three-architecture QEMU acceptance logs.
- **[patent/](patent/)** — Provisional patent application source. **Legal hold —
ask Bob before touching anything in this directory.**
- **[api/](api/)** — Generated Doxygen tag file and warnings log (gitignored;
not part of the tracked doc tree).
- **[pptx/](pptx/)** — Elevator-pitch and deep-dive slide decks for different
audiences (technical, non-technical, academic, PhD-level).
## Current Active Work
- **LithosAnanke M7/M7.1** — VM parity validation and init capsule architecture.
See `lithosananke/README.md` and `lithosananke/M7.1.md`.
- **Word-level ACL system** — Phase 6 complete on `master`; Phase 7 (LithosAnanke
parity) is the next step. See `03-architecture/word-acl/README.md`.
- **Tripod VMs** — Hera (governor), Hermes (messenger), Artemis (memory/block
storage). See `03-architecture/tripod/README.md` and `birthing/`.
## Contributing
- Place new material in `working/` first; promote to `formal/` only when it's
ready to be cited (see `formal/CLAUDE.md` for promotion criteria).
- Never touch `patent/`, `formal/patent/`, `formal/scraps/legal/`, or
`working/legal/` without Bob's explicit instruction.
- Add a `README.md` to any new category-level subdirectory, following the
format used throughout this tree: orientation paragraph + bullet list of
real files with one-line descriptions.