Files
SubMiner/docs-site
sudacode 166015897d rename config window to settings and update CLI entry points
- Replace `--config`/`subminer config` (no action) with `--settings`/`subminer settings`
- `subminer config` now requires an explicit action (`path` or `show`)
- `--settings` previously opened Yomitan; replaced by `--yomitan`
- Linux tray update installs AppImage via electron-updater instead of manual flow
- macOS update dialog activation and curl-fetch routing fixes
- Delete stale compiled artifacts (main.js, app-updater.js)
2026-05-20 20:31:02 -07:00
..
2026-03-10 19:47:16 -07:00

SubMiner Docs

In-repo VitePress documentation source for SubMiner.

Internal architecture/workflow source of truth lives in docs/README.md at the repo root. Keep docs-site/ user-facing.

Local development

bun --cwd docs-site install
bun run docs:dev

Build and preview:

bun run docs:build
bun run docs:preview
bun run docs:test

Direct package commands still work from docs-site/ if you prefer:

cd docs-site
bun install
bun run docs:dev

Cloudflare Pages

  • Git repo: ksyasuda/SubMiner
  • Production branch: main
  • Automatic production and preview deployments: disabled
  • Custom domain: docs.subminer.moe attached to Production
  • Deployment path: GitHub Actions direct upload with Wrangler

The public docs root is stable-only:

  • / serves the latest stable release docs.
  • /main/ serves development docs from main and is marked noindex,follow.
  • /v/<version>/ serves stable release archives.
  • Prerelease tags do not update the docs site.

Keep Cloudflare Git auto-deploy disabled. The production deploy is .github/workflows/docs-pages.yml, which uploads .tmp/docs-versioned-site with --branch main so tag-triggered runs update Production instead of creating preview deployments.