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:
@@ -90,3 +90,7 @@ Read first. Keep concise.
|
||||
| `codex-overlay-three-window-layout-20260223T021606Z-9z2t` | `codex-overlay-three-window-layout` | `Implement top-anchored secondary subtitle overlay window (20%) plus swappable primary overlay region (80%).` | `handoff` | `docs/subagents/agents/codex-overlay-three-window-layout-20260223T021606Z-9z2t.md` | `2026-02-23T02:44:37Z` |
|
||||
| `opencode-task110-backlog-sync-20260223T025059Z-k3m7` | `opencode-task110-backlog-sync` | `Verify TASK-110 completion state and synchronize backlog metadata with plan-first workflow.` | `handoff` | `docs/subagents/agents/opencode-task110-backlog-sync-20260223T025059Z-k3m7.md` | `2026-02-23T02:53:30Z` |
|
||||
| `codex-docs-page-polish-20260223T025932Z-b7k2` | `codex-docs-page-polish` | `Polish docs landing page and sync public workflow docs with current overlay stack.` | `handoff` | `docs/subagents/agents/codex-docs-page-polish-20260223T025932Z-b7k2.md` | `2026-02-23T03:19:20Z` |
|
||||
| `opencode-remove-maint-guardrails-20260223T033715Z-2a53` | `opencode-remove-maint-guardrails` | `Remove Maintainability Guardrails docs section and associated guardrail code/commands.` | `handoff` | `docs/subagents/agents/opencode-remove-maint-guardrails-20260223T033715Z-2a53.md` | `2026-02-23T03:40:20Z` |
|
||||
| `codex-architecture-doc-refresh-20260223T033941Z-d6se` | `codex-architecture-doc-refresh` | `Review repository architecture surfaces and refresh docs/architecture.md content to match current code state.` | `handoff` | `docs/subagents/agents/codex-architecture-doc-refresh-20260223T033941Z-d6se.md` | `2026-02-23T03:44:17Z` |
|
||||
| `codex-docs-video-thumb-cache-20260223T033929Z-k8p2` | `codex-docs-video-thumb-cache` | `Fix docs landing page demo video thumbnail staleness after direct asset replacement.` | `handoff` | `docs/subagents/agents/codex-docs-video-thumb-cache-20260223T033929Z-k8p2.md` | `2026-02-23T03:44:04Z` |
|
||||
| `codex-development-docs-review-20260223T034520Z-2ebb` | `codex-development-docs-review` | `Review codebase and refresh docs/development.md to match current project state.` | `done` | `docs/subagents/agents/codex-development-docs-review-20260223T034520Z-2ebb.md` | `2026-02-23T03:49:16Z` |
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# Agent: `codex-architecture-doc-refresh-20260223T033941Z-d6se`
|
||||
|
||||
- alias: `codex-architecture-doc-refresh`
|
||||
- mission: `Review current runtime/module architecture and update docs/architecture.md content to match real code paths.`
|
||||
- status: `handoff`
|
||||
- branch: `main`
|
||||
- started_at: `2026-02-23T03:39:41Z`
|
||||
- heartbeat_minutes: `5`
|
||||
|
||||
## Current Work (newest first)
|
||||
- [2026-02-23T03:44:17Z] handoff: architecture docs refreshed to match current codebase structure/runtime ownership; docs build passed; ready for user review.
|
||||
- [2026-02-23T03:44:17Z] test: `bun run docs:build` passed.
|
||||
- [2026-02-23T03:44:17Z] progress: updated `docs/architecture.md` sections for project structure, service layer, renderer layering, lifecycle, composition conventions, and extension rules; mermaid blocks left unchanged.
|
||||
- [2026-02-23T03:39:41Z] intent: refresh `docs/architecture.md` using direct repo evidence; keep diagrams untouched per user request.
|
||||
- [2026-02-23T03:39:41Z] progress: loaded `docs/subagents/INDEX.md`, `docs/subagents/collaboration.md`, current `docs/architecture.md`, and source tree inventory.
|
||||
|
||||
## Files Touched
|
||||
- `docs/subagents/INDEX.md`
|
||||
- `docs/subagents/collaboration.md`
|
||||
- `docs/subagents/agents/codex-architecture-doc-refresh-20260223T033941Z-d6se.md`
|
||||
- `backlog/tasks/task-113 - Refresh-architecture-doc-content-to-match-current-codebase.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
## Assumptions
|
||||
- User wants content accuracy only; mermaid/flow diagrams intentionally left as-is.
|
||||
- Existing uncommitted guardrail-removal changes are separate work; avoid touching those files.
|
||||
|
||||
## Open Questions / Blockers
|
||||
- None.
|
||||
|
||||
## Next Step
|
||||
- Await user follow-up; if requested, apply same drift pass to other docs pages (`docs/development.md`, `docs/mining-workflow.md`).
|
||||
@@ -0,0 +1,31 @@
|
||||
# Agent: `codex-development-docs-review-20260223T034520Z-2ebb`
|
||||
|
||||
- alias: `codex-development-docs-review`
|
||||
- mission: `Review codebase and refresh docs/development.md to match current project state.`
|
||||
- status: `done`
|
||||
- branch: `main`
|
||||
- started_at: `2026-02-23T03:46:06Z`
|
||||
- heartbeat_minutes: `5`
|
||||
|
||||
## Current Work (newest first)
|
||||
- [2026-02-23T03:49:16Z] handoff: refreshed `docs/development.md` for current setup/build/test/env workflow; validated with `bun run docs:build`; updated backlog ticket + subagent bookkeeping.
|
||||
- [2026-02-23T03:48:30Z] test: `bun run docs:build` passed after docs edits (VitePress chunk-size warning only).
|
||||
- [2026-02-23T03:47:40Z] progress: fixed setup drift (`pnpm` -> `bun`, added submodule init), aligned testing section with CI lanes, corrected subtitle test placeholder wording, expanded env vars to active launcher/runtime overrides.
|
||||
- [2026-02-23T03:46:06Z] intent: initialize subagent+backlog bookkeeping, then audit `docs/development.md` against actual scripts/tests/runtime layout before editing docs.
|
||||
|
||||
## Files Touched
|
||||
- `docs/subagents/agents/codex-development-docs-review-20260223T034520Z-2ebb.md`
|
||||
- `docs/subagents/INDEX.md`
|
||||
- `docs/subagents/collaboration.md`
|
||||
- `backlog/tasks/task-114 - Refresh-development-doc-content-to-match-current-codebase.md`
|
||||
- `docs/development.md`
|
||||
|
||||
## Assumptions
|
||||
- `Backlog.md` is managed via `backlog/` markdown files in this repo; create a new task ticket for this request.
|
||||
- Existing dirty worktree entries are from prior sessions; avoid touching unrelated lines/files.
|
||||
|
||||
## Open Questions / Blockers
|
||||
- None.
|
||||
|
||||
## Next Step
|
||||
- Await user review/follow-up scope.
|
||||
@@ -0,0 +1,39 @@
|
||||
# Agent: `codex-docs-video-thumb-cache-20260223T033929Z-k8p2`
|
||||
|
||||
- alias: `codex-docs-video-thumb-cache`
|
||||
- mission: `Fix docs landing page demo video thumbnail staleness after direct asset replacement`
|
||||
- status: `handoff`
|
||||
- branch: `main`
|
||||
- started_at: `2026-02-23T03:40:48Z`
|
||||
- heartbeat_minutes: `5`
|
||||
|
||||
## Current Work
|
||||
- [2026-02-23T03:40:48Z] intent: confirm root cause for stale docs video thumbnail and apply minimal cache-busting/docs fix.
|
||||
- [2026-02-23T03:40:48Z] plan: touch `docs/index.md`; add regression coverage if lightweight; validate with docs build/targeted test.
|
||||
- [2026-02-23T03:40:48Z] assumption: stale thumbnail caused by static poster/source URLs reusing identical path after direct file replacement.
|
||||
- [2026-02-23T03:42:25Z] progress: added failing regression test `docs/index.assets.test.ts` asserting shared cache-busting token across demo media URLs.
|
||||
- [2026-02-23T03:42:58Z] progress: generated fresh poster from `docs/public/assets/minecard.webm` (`minecard-poster.jpg`) and wired docs video block to shared `demoAssetVersion` tokenized URLs.
|
||||
- [2026-02-23T03:43:20Z] test: `bun test docs/index.assets.test.ts` passes (1/1).
|
||||
- [2026-02-23T03:43:35Z] test: `bun run docs:build` passes.
|
||||
- [2026-02-23T03:43:55Z] handoff: TASK-112 marked Done with implementation notes and validation commands.
|
||||
- [2026-02-23T03:44:04Z] progress: regenerated `minecard-poster.jpg` from `minecard.webm` at exactly `00:00:12` and bumped `demoAssetVersion` to `20260223-2` to force refresh.
|
||||
- [2026-02-23T03:44:04Z] test: reran `bun test docs/index.assets.test.ts` (pass).
|
||||
|
||||
## Files Touched
|
||||
- `docs/subagents/agents/codex-docs-video-thumb-cache-20260223T033929Z-k8p2.md`
|
||||
- `docs/subagents/INDEX.md`
|
||||
- `docs/subagents/collaboration.md`
|
||||
- `backlog/tasks/task-112 - Fix-docs-demo-video-thumbnail-cache-staleness.md`
|
||||
- `docs/index.assets.test.ts`
|
||||
- `docs/index.md`
|
||||
- `docs/public/assets/minecard-poster.jpg`
|
||||
|
||||
## Assumptions
|
||||
- Browser/CDN cache can keep prior media when URL path remains unchanged.
|
||||
- Docs home video section in `docs/index.md` is the only requested scope.
|
||||
|
||||
## Open Questions / Blockers
|
||||
- None.
|
||||
|
||||
## Next Step
|
||||
- Share fix summary and ask user to hard-refresh docs page once (`Cmd+Shift+R`) to bypass local cache.
|
||||
@@ -0,0 +1,46 @@
|
||||
# Agent: `opencode-remove-maint-guardrails-20260223T033715Z-2a53`
|
||||
|
||||
- alias: `opencode-remove-maint-guardrails`
|
||||
- mission: `Remove Maintainability Guardrails docs section and associated guardrail code/commands.`
|
||||
- status: `handoff`
|
||||
- branch: `main`
|
||||
- started_at: `2026-02-23T03:37:39Z`
|
||||
- heartbeat_minutes: `5`
|
||||
|
||||
## Current Work (newest first)
|
||||
|
||||
- [2026-02-23T03:40:20Z] handoff: completed TASK-111; removed docs section, package scripts, CI guardrail step, and runtime-cycle/fan-in script code + fixtures; validation (`bun run tsc --noEmit`, `bun run docs:build`) passed.
|
||||
- [2026-02-23T03:40:03Z] progress: removed `## Maintainability Guardrails` from `docs/development.md`, deleted `check:main-fanin*` and `check:runtime-cycles*` scripts from `package.json`, removed CI fail-fast guardrails step, and deleted associated scripts/fixtures under `scripts/`.
|
||||
- [2026-02-23T03:37:39Z] intent: initialized session, linked backlog task TASK-111, and preparing scoped removal pass for maintainability guardrails docs and related code.
|
||||
- [2026-02-23T03:37:39Z] assumptions: removal target is explicit "Maintainability Guardrails" section and direct command/code references tied to it.
|
||||
|
||||
## Files Touched
|
||||
|
||||
- `docs/subagents/INDEX.md`
|
||||
- `docs/subagents/collaboration.md`
|
||||
- `docs/subagents/agents/opencode-remove-maint-guardrails-20260223T033715Z-2a53.md`
|
||||
- `backlog/tasks/task-111 - Remove-Maintainability-Guardrails-docs-section-and-related-guardrail-code.md` (via Backlog MCP)
|
||||
- `docs/development.md`
|
||||
- `package.json`
|
||||
- `.github/workflows/ci.yml`
|
||||
- `scripts/check-main-runtime-fanin.ts` (deleted)
|
||||
- `scripts/check-runtime-cycles.ts` (deleted)
|
||||
- `scripts/check-runtime-cycles.test.ts` (deleted)
|
||||
- `scripts/fixtures/runtime-cycles/acyclic/entry.ts` (deleted)
|
||||
- `scripts/fixtures/runtime-cycles/acyclic/feature.ts` (deleted)
|
||||
- `scripts/fixtures/runtime-cycles/acyclic/utils/index.ts` (deleted)
|
||||
- `scripts/fixtures/runtime-cycles/cyclic/module-a.ts` (deleted)
|
||||
- `scripts/fixtures/runtime-cycles/cyclic/module-b.ts` (deleted)
|
||||
- `scripts/fixtures/runtime-cycles/cyclic/nested/index.ts` (deleted)
|
||||
|
||||
## Assumptions
|
||||
|
||||
- Request targets current docs page section shown in screenshot and associated command/code paths, not unrelated guardrails.
|
||||
|
||||
## Open Questions / Blockers
|
||||
|
||||
- None.
|
||||
|
||||
## Next Step
|
||||
|
||||
- Await user follow-up (optional commit/changelog pass if requested).
|
||||
@@ -157,3 +157,12 @@ Shared notes. Append-only.
|
||||
- [2026-02-23T02:44:37Z] [codex-overlay-three-window-layout-20260223T021606Z-9z2t|codex-overlay-three-window-layout] backlog sync requested post-commit; updated TASK-110 `updated_date`, added commit reference (`b8f7d5e`), and added final summary block.
|
||||
- [2026-02-23T02:50:59Z] [opencode-task110-backlog-sync-20260223T025059Z-k3m7|opencode-task110-backlog-sync] starting TASK-110 closure verification pass via Backlog MCP + writing-plans/executing-plans workflow; scope backlog metadata validation/sync only unless missing evidence is found.
|
||||
- [2026-02-23T02:53:30Z] [opencode-task110-backlog-sync-20260223T025059Z-k3m7|opencode-task110-backlog-sync] completed verification/sync: recorded closure plan, revalidated commit/code evidence (parallel subagent audits), appended TASK-110 verification note, and confirmed task remains Done with all AC checked.
|
||||
- [2026-02-23T03:37:39Z] [opencode-remove-maint-guardrails-20260223T033715Z-2a53|opencode-remove-maint-guardrails] starting TASK-111 removal pass: delete docs section "Maintainability Guardrails" and remove associated guardrail command/code references; scope docs/scripts/config only.
|
||||
- [2026-02-23T03:40:20Z] [opencode-remove-maint-guardrails-20260223T033715Z-2a53|opencode-remove-maint-guardrails] completed TASK-111: removed maintainability guardrails docs section, deleted fan-in/runtime-cycle scripts + fixtures, removed related package scripts and CI step, validated via `bun run tsc --noEmit` and `bun run docs:build`.
|
||||
- [2026-02-23T03:39:41Z] [codex-architecture-doc-refresh-20260223T033941Z-d6se|codex-architecture-doc-refresh] starting docs drift audit for `docs/architecture.md`; scope is content-only refresh vs current `src/**` architecture (no mermaid/chart edits), avoiding active guardrail-removal files.
|
||||
- [2026-02-23T03:40:48Z] [codex-docs-video-thumb-cache-20260223T033929Z-k8p2|codex-docs-video-thumb-cache] starting docs bugfix for stale home demo thumbnail after direct video replacement; scope `docs/index.md` plus lightweight regression coverage/backlog linkage only.
|
||||
- [2026-02-23T03:43:55Z] [codex-docs-video-thumb-cache-20260223T033929Z-k8p2|codex-docs-video-thumb-cache] completed TASK-112: generated `minecard-poster.jpg` from latest webm, switched docs demo media URLs to shared cache-busting token, added `docs/index.assets.test.ts`, and validated with `bun test docs/index.assets.test.ts` + `bun run docs:build`.
|
||||
- [2026-02-23T03:44:04Z] [codex-docs-video-thumb-cache-20260223T033929Z-k8p2|codex-docs-video-thumb-cache] user follow-up applied: regenerated poster at exact `00:00:12` from `minecard.webm` and bumped docs asset token to `20260223-2` to force static thumbnail refresh.
|
||||
- [2026-02-23T03:44:17Z] [codex-architecture-doc-refresh-20260223T033941Z-d6se|codex-architecture-doc-refresh] completed architecture drift pass: refreshed `docs/architecture.md` structure/service/composition/lifecycle content against current code (`src`, `launcher`, `plugin`), left mermaid sections untouched, and verified `bun run docs:build`; moved backlog linkage to `TASK-113` to avoid active `TASK-112` collision.
|
||||
- [2026-02-23T03:46:06Z] [codex-development-docs-review-20260223T034520Z-2ebb|codex-development-docs-review] starting user-requested thorough codebase + `docs/development.md` drift audit; scope docs refresh + verification only, no runtime behavior changes expected.
|
||||
- [2026-02-23T03:49:16Z] [codex-development-docs-review-20260223T034520Z-2ebb|codex-development-docs-review] completed `docs/development.md` refresh: setup/deps/submodule instructions corrected, CI-parity testing lane documented, placeholder subtitle test status clarified, Makefile reference adjusted, env variable table expanded to active launcher/runtime overrides; `bun run docs:build` passed.
|
||||
|
||||
Reference in New Issue
Block a user