2.8 KiB
id, title, status, assignee, created_date, updated_date, labels, dependencies, references, priority
| id | title | status | assignee | created_date | updated_date | labels | dependencies | references | priority | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| TASK-117 | Prepare initial Windows release docs and version bump | Done |
|
2026-03-08 15:17 | 2026-03-08 15:17 |
|
|
medium |
Description
Prepare the initial packaged Windows release by bumping the app version and refreshing the release-facing README/backlog/docs surfaces so install and direct-command guidance no longer reads Linux-only.
Acceptance Criteria
- #1 App version is bumped for the Windows release cut
- #2 README and sibling docs describe Windows packaged installation alongside Linux/macOS guidance
- #3 Backlog records the release-doc/version update with the modified references
Implementation Plan
- Bump the package version for the release cut.
- Update the root README install/start guidance to mention Windows packaged builds.
- Patch the sibling docs repo installation, usage, and changelog pages for the Windows release.
- Record the work in Backlog and run targeted verification on the touched surfaces.
Implementation Notes
The public README still advertised Linux/macOS only, while the sibling docs had Windows-specific runtime notes but no actual Windows install section and several direct-command examples still assumed SubMiner.AppImage.
Bumped package.json to 0.5.0, expanded the README platform/install copy to include Windows, added a Windows install section to ../subminer-docs/installation.md, clarified in ../subminer-docs/usage.md that direct packaged-app examples use SubMiner.exe on Windows, and added a v0.5.0 changelog entry covering the initial Windows release plus the latest overlay behavior polish.
Final Summary
Prepared the initial Windows release documentation pass and version bump. package.json now reports 0.5.0. The root README.md now advertises Linux, macOS, and Windows support, includes Windows packaged-install guidance, and clarifies first-launch behavior across platforms. In the sibling docs repo, installation.md now includes a dedicated Windows install section, usage.md explains that direct packaged-app examples use SubMiner.exe on Windows, and changelog.md now includes the v0.5.0 release notes for the initial Windows build and recent overlay behavior changes.
Verification: targeted bun run tsc --noEmit -p tsconfig.typecheck.json in the app repo and bun run docs:build in ../subminer-docs.