Files
SubMiner/docs-site
sudacode 3a97239ade feat(overlay): add in-app changelog modal
- Add a changelog modal opened from tray "View Changelog" or the update notification's "What's New" button; renders in-player or in its own window like the help modal
- Fetch changelog from the newest published release so newer-than-installed notes are visible, falling back to the bundled CHANGELOG.md on failure
- Group versions by minor line (current expanded, older folded), badge the installed version, tag newer ones "New"
- Support J/K/arrow navigation, Enter to fold/unfold, R to refetch, Esc to close
- Add changelog parsing/semver-compare utils and changelog IPC channel/runtime; bundle CHANGELOG.md into packaged builds
- Replace release/release-notes.md with changes/changelog-modal.md changeset entry
2026-08-05 01:20:52 -07:00
..
2026-03-10 19:47:16 -07:00
2026-08-04 18:51:15 -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.