Documentation
Kept separately, in MkDocs, where it changes at the speed of the code rather than the speed of a marketing page. Each site states what its product does not do as plainly as what it does.
-
RevFramework
Every system, how to wire it up, and what it deliberately does not do.
- Getting started and install location
- Module dependencies and service classes
- Why it works this way
- The Cookbook
- Testing
- Changelog
Onboarding video series (opens in a new tab) (opens in a new tab) Including a live demonstration of removing systems from a working project and putting them back.
-
Snap Studio Pro
Every panel and every workflow, with a screenshot of each.
- Your first sprite, and a tour of the window
- Directional capture, animation export, batch export
- Framing, lighting, shadows, backgrounds, post-processing
- Particle and VFX Graph capture
- Render pipelines and URP transparency
- The headless API and settings profiles
-
RevLearning
Both SCORM standards and xAPI, and what actually differs once a real LMS is reading.
- Getting started and the mental model
- SCORM 1.2 and 2004 runtimes, helpers and data types
- xAPI transport, serialization and extensions
- WebGL config and the jslib bridge
- Build, packaging and the validator
- LMS conformance results
04 — Everything else
What isn’t here, and where it is instead
Three products have published documentation sites. The rest do not, and saying so is more useful than a page of links that turn out to be empty.
- LoggerPro
- Documentation ships inside the package, beside the code it describes.
- Moniker · Rev Diagnostics · Skint
- Not released yet. Each ships its documentation with it.
- ORDA
- A game in development, not a documented product. Its development record is kept privately and honestly rather than published as marketing.