Files
SubMiner/backlog/tasks/task-116 - Audit-branch-commits-for-remaining-subminer-docs-updates.md

2.7 KiB

id, title, status, assignee, created_date, updated_date, labels, dependencies, references, priority, ordinal
id title status assignee created_date updated_date labels dependencies references priority ordinal
TASK-116 Audit branch commits for remaining subminer-docs updates Done
codex
2026-03-08 00:46 2026-03-16 05:13
docs
../subminer-docs/installation.md
../subminer-docs/troubleshooting.md
src/core/services/yomitan-extension-paths.ts
scripts/build-yomitan.mjs
medium 66500

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

  • #1 Reviewed recent branch commits for user-facing or contributor-facing changes that may require docs updates
  • #2 Updated subminer-docs pages where branch changes introduced concrete doc drift
  • #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.