Developer Docs

This page is the public map from website readers to the implementation structure.

Important source files

File or directory	Purpose
`README.md`	Workspace overview and command entry.
`tinyrustlm/README.md`	TinyRustLM app and runtime overview.
`tinyrustlm/docs/architecture.md`	Architecture detail.
`tinyrustlm/docs/browser-runtime.md`	Browser-local runtime detail.
`tinyrustlm/docs/slm-format.md`	`.slm` model format detail.
`tinyrustlm/docs/tokenizer.md`	Byte tokenizer and BPE fixture rules.
`tinyrustlm/docs/quantization.md`	f32/q8_0/q4_0 support boundaries.
`tinyrustlm/docs/testing.md`	Test matrix and proof expectations.
`tinyrustlm/docs/performance.md`	Scratch, logits, sampling, output cap, and benchmark guidance.
`wiki/runtime-mirust/`	Local LLM Wiki source namespace.
`.uai/`	Project handoff memory and source routing.

Useful local commands

The exact command set evolves with the source tree, but the public site can safely describe the command families:

cargo fmt --all
cargo test --workspace
cargo run -p tinyrustlm-browser-harness -- tinyrustlm
node tinyrustlm/tools/wasm-abi-smoke.js
node tinyrustlm/tools/browser-smoke.js

Visual Studio wrapper scripts live under tools/vs/ for build, run, and test flows.

Website content rule

Developer docs on this site should summarize source-backed boundaries. They should not replace the repository docs, and they should not claim support that the tests do not support.

Agent-readable docs

This site exposes llms.txt, llms-full.txt, Markdown alternates, and semantic page structure so AI systems can cite the project accurately without scraping a generic plain PHP shell.

Root /docs corpus

The full root package also publishes /docs/index.md, /docs/reports/index.md, and /docs/long-term-memory.uai. The hot .uai deep-link map is /.uai/docs-routing.uai.