Files
SubMiner/backlog/tasks/task-168 - Document-immersion-stats-dashboard-and-config.md

1.6 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-168 Document immersion stats dashboard and config Done
codex
2026-03-12 22:53 2026-03-16 05:13
docs
immersion
medium 24500

Description

Refresh user-facing docs for the new immersion stats dashboard so README, docs-site pages, changelog notes, and generated config examples describe how to access the dashboard and which stats.* settings control it.

Acceptance Criteria

  • #1 README mentions the new stats surface in product-facing feature/docs copy.
  • #2 Docs explain how to access the stats dashboard in-app and via localhost, and document the stats config block.
  • #3 Changelog/release-note input includes the new stats dashboard.
  • #4 Generated config examples include the new stats section.

Final Summary

Updated README and the docs-site immersion/config/mining/shortcut/homepage copy to describe the new stats dashboard, including the overlay toggle (stats.toggleKey, default Backquote) and the localhost browser UI (http://127.0.0.1:5175 by default).

Added a changelog fragment for the stats dashboard release notes and extended the config template sections so regenerated config.example.jsonc artifacts now include the stats block.

Verified with bun run test:config, bun run generate:config-example, bun run docs:test, bun run docs:build, and bun run changelog:lint.