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 9f0f8a2ce9
commit 781e6dd4fa
16 changed files with 1045 additions and 1295 deletions

View File

@@ -24,8 +24,8 @@ export default {
{ text: 'Docs', link: '/' },
{ text: 'Installation', link: '/installation' },
{ text: 'Usage', link: '/usage' },
{ text: 'Mining', link: '/mining-workflow' },
{ text: 'Configuration', link: '/configuration' },
{ text: 'Development', link: '/development' },
{ text: 'Architecture', link: '/architecture' },
],
sidebar: [
@@ -35,12 +35,21 @@ export default {
{ text: 'Overview', link: '/' },
{ text: 'Installation', link: '/installation' },
{ text: 'Usage', link: '/usage' },
{ text: 'Mining Workflow', link: '/mining-workflow' },
],
},
{
text: 'Reference',
items: [
{ text: 'Configuration', link: '/configuration' },
{ text: 'Anki Integration', link: '/anki-integration' },
{ text: 'MPV Plugin', link: '/mpv-plugin' },
{ text: 'Troubleshooting', link: '/troubleshooting' },
],
},
{
text: 'Development',
items: [
{ text: 'Development', link: '/development' },
{ text: 'Architecture', link: '/architecture' },
],

View File

@@ -1,7 +1,6 @@
import DefaultTheme from 'vitepress/theme';
import { useRoute } from 'vitepress';
import { nextTick, onMounted, watch } from 'vue';
import mermaid from 'mermaid';
import '@catppuccin/vitepress/theme/macchiato/mauve.css';
import './mermaid-modal.css';
@@ -107,7 +106,8 @@ function attachMermaidInteractions(nodes: HTMLElement[]) {
async function getMermaid() {
if (!mermaidLoader) {
mermaidLoader = Promise.resolve().then(() => {
mermaidLoader = import('mermaid').then((module) => {
const mermaid = module.default;
mermaid.initialize({
startOnLoad: false,
securityLevel: 'loose',