mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
docs: refresh architecture and development docs
Update docs content to match current launcher/plugin/runtime structure and fix stale home demo media assets with cache-busted URLs plus poster refresh. Add supporting backlog/subagent tracking records and docs asset regression coverage.
This commit is contained in:
@@ -0,0 +1,50 @@
|
||||
---
|
||||
id: TASK-112
|
||||
title: Fix docs demo video thumbnail cache staleness
|
||||
status: Done
|
||||
assignee:
|
||||
- codex
|
||||
created_date: '2026-02-23 03:41'
|
||||
updated_date: '2026-02-23 03:43'
|
||||
labels:
|
||||
- bug
|
||||
- docs
|
||||
- media
|
||||
dependencies: []
|
||||
priority: medium
|
||||
ordinal: 112000
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||
Docs home page demo continues to show an old thumbnail after replacing the demo video file in place. The page currently reuses static media URLs (`/assets/minecard.webm`, `/assets/minecard.mp4`, `/assets/demo-poster.jpg`), so browser/CDN cache can keep stale poster/video preview data.
|
||||
<!-- SECTION:DESCRIPTION:END -->
|
||||
|
||||
## Action Steps
|
||||
|
||||
<!-- SECTION:PLAN:BEGIN -->
|
||||
1. Add a failing regression check that asserts cache-busted URL usage for docs home demo media references.
|
||||
2. Update docs home demo media URLs to include a shared asset version token for poster/source/fallback paths.
|
||||
3. Run the regression check and docs build validation.
|
||||
4. Record fix notes and move task status to Done.
|
||||
<!-- SECTION:PLAN:END -->
|
||||
|
||||
## Acceptance Criteria
|
||||
<!-- AC:BEGIN -->
|
||||
- [x] #1 Docs home video references include a deterministic cache-busting token so direct asset replacement does not serve stale preview data.
|
||||
- [x] #2 Poster/source/fallback links in the demo block use the same token to avoid mixed old/new media.
|
||||
- [x] #3 Validation commands for the new regression check and docs build pass.
|
||||
<!-- AC:END -->
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
<!-- SECTION:NOTES:BEGIN -->
|
||||
- Generated a fresh thumbnail from `docs/public/assets/minecard.webm` into `docs/public/assets/minecard-poster.jpg`.
|
||||
- Updated `docs/index.md` demo block to use a shared `demoAssetVersion` token across poster, webm/mp4 sources, and gif fallback links.
|
||||
- Follow-up: regenerated `minecard-poster.jpg` at exact `00:00:12` from the webm and bumped token to `demoAssetVersion = '20260223-2'`.
|
||||
- Added regression check `docs/index.assets.test.ts` to ensure demo media references keep shared cache-busting URL patterns.
|
||||
- Validation:
|
||||
- `bun test docs/index.assets.test.ts`
|
||||
- `bun run docs:build`
|
||||
<!-- SECTION:NOTES:END -->
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: TASK-113
|
||||
title: Refresh architecture doc content to match current codebase
|
||||
status: Done
|
||||
assignee:
|
||||
- codex-architecture-doc-refresh
|
||||
created_date: '2026-02-22 19:39'
|
||||
updated_date: '2026-02-22 19:44'
|
||||
labels:
|
||||
- docs
|
||||
- architecture
|
||||
dependencies: []
|
||||
priority: low
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||
User requested a thorough review of the current codebase and `docs/architecture.md`, then updating document content to reflect current implementation details. Mermaid/flow diagrams are explicitly out of scope for this pass.
|
||||
<!-- SECTION:DESCRIPTION:END -->
|
||||
|
||||
## Acceptance Criteria
|
||||
<!-- AC:BEGIN -->
|
||||
- [x] #1 Architecture content sections align with current source tree/module ownership.
|
||||
- [x] #2 Service/composer/runtime descriptions are updated for current behavior and module names.
|
||||
- [x] #3 Mermaid/flow chart sections remain unchanged in this pass.
|
||||
<!-- AC:END -->
|
||||
|
||||
## Notes
|
||||
|
||||
- Reviewed current module ownership across `src/main.ts`, `src/main/runtime/*`, `src/core/services/*`, `src/config/*`, `src/renderer/*`, `launcher/*`, and `plugin/subminer.lua`.
|
||||
- Updated `docs/architecture.md` content sections only; Mermaid blocks intentionally left untouched.
|
||||
- Verification: `bun run docs:build` passed.
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: TASK-114
|
||||
title: Refresh development doc content to match current codebase
|
||||
status: Done
|
||||
assignee:
|
||||
- codex-development-docs-review
|
||||
created_date: '2026-02-23 03:46'
|
||||
updated_date: '2026-02-23 03:49'
|
||||
labels:
|
||||
- docs
|
||||
- developer-experience
|
||||
dependencies: []
|
||||
priority: medium
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||
User requested a thorough review of the current codebase and `docs/development.md`, then updates so the page reflects current scripts, architecture, and contributor workflow.
|
||||
<!-- SECTION:DESCRIPTION:END -->
|
||||
|
||||
## Acceptance Criteria
|
||||
<!-- AC:BEGIN -->
|
||||
- [x] #1 `docs/development.md` commands/tooling sections match current `package.json`, `Makefile`, and active CI lanes.
|
||||
- [x] #2 Runtime/composition guidance reflects current module ownership and does not reference removed guardrail steps.
|
||||
- [x] #3 Updated doc builds cleanly via `bun run docs:build`.
|
||||
<!-- AC:END -->
|
||||
|
||||
## Notes
|
||||
|
||||
- Reviewed `docs/development.md` against current `package.json` scripts, `Makefile` targets, launcher/runtime env overrides, and `.github/workflows/ci.yml` gate order.
|
||||
- Updated setup instructions to use Bun for `vendor/texthooker-ui` and include submodule initialization.
|
||||
- Added CI-equivalent local test/build/docs command sequence and clarified that subtitle dist tests are currently placeholders.
|
||||
- Expanded environment-variable coverage (`SUBMINER_ROFI_THEME`, Jimaku/Jellyfin overrides, `SUBMINER_LOG_LEVEL`, `SUBMINER_MPV_LOG`, macOS helper skip flag).
|
||||
- Verification: `bun run docs:build` passed.
|
||||
Reference in New Issue
Block a user