Files
SubMiner/backlog/tasks/task-105 - Stop-local-docs-artifact-writes-after-docs-repo-split.md
sudacode 5d96f9d535 Add annotation websocket and texthooker startup config
- Add `texthooker.launchAtStartup` (default `true`) and wire startup behavior
- Add dedicated `annotationWebsocket` config/service path (default port `6678`) for texthooker annotations
- Regenerate config example/tests and update Yomitan patching/vendor assets
2026-03-07 01:41:08 -08:00

1.7 KiB

id, title, status, assignee, created_date, updated_date, labels, dependencies, priority, ordinal
id title status assignee created_date updated_date labels dependencies priority ordinal
TASK-105 Stop local docs artifact writes after docs repo split Done
2026-03-07 00:00 2026-03-07 00:20
medium 10500

Description

Now that user-facing docs live in ../subminer-docs, first-party scripts in this repo should not keep writing generated artifacts into the local docs/ tree.

Scope:

  • Audit first-party scripts/automation for writes to docs/.
  • Keep repo-local outputs only where they are still intentionally owned by this repo.
  • Repoint generated docs artifacts to ../subminer-docs when that is the maintained source of truth.
  • Add regression coverage for the config-example generation path contract.

Acceptance Criteria

  • #1 The config-example generator no longer writes to docs/public/config.example.jsonc inside this repo.
  • #2 When ../subminer-docs exists, the generator updates ../subminer-docs/public/config.example.jsonc.
  • #3 Automated coverage guards the output-path contract so local docs writes do not regress.

Final Summary

Removed the first-party local docs/public config-example write path from src/generate-config-example.ts and replaced it with sibling-docs-repo detection that targets ../subminer-docs/public/config.example.jsonc only when that repo exists.

Added a project-local regression suite for output-path resolution and artifact writing, wired that suite into the maintained config test lane, and removed the stale generated docs/public/config.example.jsonc artifact from the working tree.