From 382cd1b3d7589040bbb77df1e36d44ae053db191 Mon Sep 17 00:00:00 2001 From: sudacode Date: Sat, 7 Mar 2026 18:29:51 -0800 Subject: [PATCH] update backlog and bump package version --- ...tributor-docs-for-current-repo-workflow.md | 59 +++++++++++++++++++ ...its-for-remaining-subminer-docs-updates.md | 53 +++++++++++++++++ package.json | 2 +- 3 files changed, 113 insertions(+), 1 deletion(-) create mode 100644 backlog/tasks/task-115 - Refresh-subminer-docs-contributor-docs-for-current-repo-workflow.md create mode 100644 backlog/tasks/task-116 - Audit-branch-commits-for-remaining-subminer-docs-updates.md diff --git a/backlog/tasks/task-115 - Refresh-subminer-docs-contributor-docs-for-current-repo-workflow.md b/backlog/tasks/task-115 - Refresh-subminer-docs-contributor-docs-for-current-repo-workflow.md new file mode 100644 index 00000000..6ee39bed --- /dev/null +++ b/backlog/tasks/task-115 - Refresh-subminer-docs-contributor-docs-for-current-repo-workflow.md @@ -0,0 +1,59 @@ +--- +id: TASK-115 +title: Refresh subminer-docs contributor docs for current repo workflow +status: Done +assignee: + - codex +created_date: '2026-03-08 00:40' +updated_date: '2026-03-08 00:42' +labels: + - docs +dependencies: [] +references: + - ../subminer-docs/development.md + - ../subminer-docs/README.md + - Makefile + - package.json +priority: medium +--- + +## Description + + +Update the sibling `subminer-docs` repo so contributor/development docs match the current SubMiner repo workflow after the docs split and recent tooling changes, including removing stale in-repo docs build steps and documenting the scoped formatting command. + + +## Acceptance Criteria + +- [x] #1 Contributor docs in `subminer-docs` no longer reference stale in-repo docs build commands for the app repo +- [x] #2 Contributor docs mention the current scoped formatting workflow (`make pretty` / `format:src`) where relevant +- [x] #3 Removed stale or no-longer-needed instructions that no longer match the current repo layout + + +## Implementation Plan + + +1. Inspect `subminer-docs` for contributor/development instructions that drifted after the docs repo split and recent tooling changes. +2. Update contributor docs to remove stale app-repo docs commands and document the current scoped formatting workflow. +3. Verify the modified docs page and build the docs site from the sibling docs repo when local dependencies are available. + + +## Implementation Notes + + +Detected concrete doc drift in `subminer-docs/development.md`: stale in-repo docs build commands and no mention of the scoped `make pretty` formatter. + +Updated `../subminer-docs/development.md` to remove stale app-repo docs build steps from the local gate, document `make pretty` / `format:check:src`, and point docs-site work to the sibling docs repo explicitly. + +Installed docs repo dependencies locally with `bun install` and verified the docs site with `bun run docs:build` in `../subminer-docs`. + +Did not change `../subminer-docs/README.md`; it was already accurate for the docs repo itself. + + +## Final Summary + + +Refreshed the contributor/development docs in the sibling `subminer-docs` repo to match the current SubMiner workflow. In `development.md`, removed the stale app-repo `bun run docs:build` step from the local CI-equivalent gate, added an explicit note to run docs builds from `../subminer-docs` when docs change, documented the scoped formatting workflow (`make pretty` and `bun run format:check:src`), and replaced the old in-repo `make docs*` instructions with the correct sibling-repo `bun run docs:*` commands. Also updated the Makefile reference to include `make pretty` and removed the obsolete `make docs-dev` entry. + +Verification: installed docs repo dependencies with `bun install` in `../subminer-docs` and ran `bun run docs:build` successfully. Left `README.md` unchanged because it was already accurate for the standalone docs repo. + diff --git a/backlog/tasks/task-116 - Audit-branch-commits-for-remaining-subminer-docs-updates.md b/backlog/tasks/task-116 - Audit-branch-commits-for-remaining-subminer-docs-updates.md new file mode 100644 index 00000000..7e1f7586 --- /dev/null +++ b/backlog/tasks/task-116 - Audit-branch-commits-for-remaining-subminer-docs-updates.md @@ -0,0 +1,53 @@ +--- +id: TASK-116 +title: Audit branch commits for remaining subminer-docs updates +status: Done +assignee: + - codex +created_date: '2026-03-08 00:46' +updated_date: '2026-03-08 00:48' +labels: + - docs +dependencies: [] +references: + - ../subminer-docs/installation.md + - ../subminer-docs/troubleshooting.md + - src/core/services/yomitan-extension-paths.ts + - scripts/build-yomitan.mjs +priority: medium +--- + +## Description + + +Review recent `yomitan-fork` commits against the sibling `subminer-docs` repo, identify any concrete documentation drift that remains after the earlier contributor-doc updates, and patch the docs for behavior/tooling changes that are now outdated or misleading. + + +## Acceptance Criteria + +- [x] #1 Reviewed recent branch commits for user-facing or contributor-facing changes that may require docs updates +- [x] #2 Updated `subminer-docs` pages where branch changes introduced concrete doc drift +- [x] #3 Verified the docs site still builds after the updates + + +## Implementation Plan + + +1. Review branch commit themes against `subminer-docs` and identify only concrete drift introduced by recent workflow/runtime changes. +2. Patch docs for the Yomitan submodule build workflow, updated source-build prerequisites, and current runtime Yomitan search paths/manual fallback path. +3. Rebuild the docs site to verify the updated pages render cleanly. + + +## Implementation Notes + + +Concrete remaining drift after commit audit: installation/development docs still understate the Node/npm + submodule requirements for the Yomitan build flow, and troubleshooting still points at obsolete `vendor/yomitan` / `extensions/yomitan` paths. + +Audited branch commits against subminer-docs coverage. Existing docs already cover first-run setup, texthooker startup/annotated websocket config, AniList merged character dictionaries, configurable collapsible sections, and subtitle name highlighting. Patched remaining drift around source-build prerequisites and Yomitan build/install paths in installation.md, development.md, and troubleshooting.md. Verified with `bun run docs:build` in ../subminer-docs. + + +## Final Summary + + +Audited branch commits for missing documentation updates in ../subminer-docs. Updated installation, development, and troubleshooting docs to match the current Yomitan submodule build flow, source-build prerequisites, and runtime extension search/manual fallback paths. Confirmed other recent branch features were already documented and rebuilt the docs site successfully. + diff --git a/package.json b/package.json index 500427d5..3e63562f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "subminer", - "version": "0.3.0", + "version": "0.4.0", "description": "All-in-one sentence mining overlay with AnkiConnect and dictionary integration", "packageManager": "bun@1.3.5", "main": "dist/main-entry.js",