Documentation

Use this directory for detailed SubMiner documentation.

Local Docs Site

Run the VitePress docs site locally:

pnpm run docs:dev

Build static docs output:

pnpm run docs:build

Installation
- Platform requirements
- AppImage / macOS / source installs
- mpv plugin setup
Usage
- Script vs plugin workflow
- Running SubMiner with mpv
- Keybindings and runtime behavior
Configuration
- Full config file reference and option details
Development
- Contributor notes
- Architecture and extension rules
- Environment variables
- License and acknowledgments
Architecture
- Service-oriented runtime structure
- Composition and lifecycle model
- Extension design rules