docs: overhaul documentation and add four new pages

- Add mining-workflow.md: end-to-end sentence mining guide
- Add anki-integration.md: AnkiConnect setup, field mapping, media generation, field grouping
- Add mpv-plugin.md: chord keybindings, subminer.conf options, script messages
- Add troubleshooting.md: common issues and solutions by category
- Rewrite architecture.md to reflect current ~1,400-line main.ts and ~35 services
- Expand development.md from ~25 lines to full dev guide
- Fix URLs to ksyasuda/SubMiner, version to v0.1.0, AppImage naming
- Update VitePress sidebar with three-group layout (Getting Started, Reference, Development)
- Update navigation in index.md, README.md, docs/README.md
- Remove obsolete planning artifacts (plan.md, investigation.md, comparison.md, composability.md, refactor-main-checklist.md)
This commit is contained in:
2026-02-10 23:25:14 -08:00
parent a861703eda
commit 4fb1c1722d
16 changed files with 1045 additions and 1295 deletions

View File

@@ -1,37 +1,23 @@
# Documentation
Use this directory for detailed SubMiner documentation.
SubMiner documentation is built with [VitePress](https://vitepress.dev/).
## Local Docs Site
Run the VitePress docs site locally:
```bash
pnpm run docs:dev
make docs-dev # Dev server at http://localhost:5173
make docs # Build static output
make docs-preview # Preview built site at http://localhost:4173
```
Build static docs output:
## Pages
```bash
pnpm run docs:build
```
- [Installation](/installation)
- Platform requirements
- AppImage / macOS / source installs
- mpv plugin setup
- [Usage](/usage)
- Script vs plugin workflow
- Running SubMiner with mpv
- Keybindings and runtime behavior
- [Configuration](/configuration)
- Full config file reference and option details
- [Development](/development)
- Contributor notes
- Architecture and extension rules
- Environment variables
- License and acknowledgments
- [Architecture](/architecture)
- Service-oriented runtime structure
- Composition and lifecycle model
- Extension design rules
- [Installation](/installation) — Platform requirements, AppImage/macOS/source installs, mpv plugin
- [Usage](/usage) — Script vs plugin workflow, keybindings, YouTube playback
- [Mining Workflow](/mining-workflow) — End-to-end sentence mining guide, overlay layers, card creation
- [Configuration](/configuration) — Full config file reference and option details
- [Anki Integration](/anki-integration) — AnkiConnect setup, field mapping, media generation, field grouping
- [MPV Plugin](/mpv-plugin) — Chord keybindings, subminer.conf options, script messages
- [Troubleshooting](/troubleshooting) — Common issues and solutions by category
- [Development](/development) — Building, testing, contributing, environment variables
- [Architecture](/architecture) — Service-oriented design, composition model, extension rules