Skip to content

Commit 35a67dc

Browse files
committed
docs(backlog): queue docs validation follow-ups
1 parent 362efb5 commit 35a67dc

1 file changed

Lines changed: 164 additions & 0 deletions

File tree

‎docs/ROADMAP/backlog/tooling-misc.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,9 @@ branch state after review-fix pushes.
470470
reply text or auto-resolve based on heuristics alone
471471
- R5: Show enough context (path, author, URL) for a reviewer to confirm the
472472
action before mutating GitHub state
473+
- R6: Reconcile current-head code state against GitHub thread state after reply
474+
/ resolve actions so outdated-but-unresolved threads are easy to distinguish
475+
from genuinely still-open review debt
473476

474477
**Acceptance Criteria:**
475478

@@ -480,6 +483,8 @@ branch state after review-fix pushes.
480483
- [ ] AC3: One command can resolve chosen thread ids after human confirmation
481484
- [ ] AC4: The helper works with the existing `gh`-based workflow
482485
- [ ] AC5: Contributor docs explain when to use it and when to reply manually
486+
- [ ] AC6: After replies / resolutions, the helper can recount unresolved
487+
threads and highlight outdated-vs-current review state explicitly
483488

484489
**Definition of Done:**
485490

@@ -770,3 +775,162 @@ judgment.
770775

771776
**Est. Hours:** 2h
772777
**Expected Complexity:** ~60 LoC (docs + links)
778+
779+
---
780+
781+
## T-10-8-17: Docs Validation Beyond Markdown
782+
783+
**User Story:** As a contributor, I want docs validation to cover the real docs
784+
surface, not just Markdown, so that broken static-HTML links and other live-doc
785+
regressions are caught before PR review.
786+
787+
**Requirements:**
788+
789+
- R1: Expand docs validation so it covers `docs/public/*.html` and any other
790+
live non-Markdown docs entrypoints
791+
- R2: Add static-HTML link and asset checks for repo-local routes and
792+
references
793+
- R3: Keep the lane scoped enough that docs-only changes remain fast to verify
794+
- R4: Document exactly which doc surfaces are covered and which are still
795+
intentionally excluded
796+
797+
**Acceptance Criteria:**
798+
799+
- [ ] AC1: A broken local route or asset reference in `docs/public/*.html`
800+
fails the docs validation lane
801+
- [ ] AC2: Docs validation is no longer effectively Markdown-only
802+
- [ ] AC3: Contributors can run one documented command to check the covered docs
803+
surfaces locally
804+
- [ ] AC4: The collision-tour style regression class is caught before review
805+
806+
**Definition of Done:**
807+
808+
- [ ] Code reviewed and merged
809+
- [ ] Tests pass (CI green)
810+
- [ ] Documentation updated (if applicable)
811+
812+
**Scope:** Validation for live docs surfaces, including Markdown plus static
813+
HTML entrypoints and their local links/assets.
814+
**Out of Scope:** External-link availability checks or full website end-to-end
815+
crawling.
816+
817+
**Test Plan:**
818+
819+
- **Goldens:** n/a
820+
- **Failures:** Intentionally break a local static-HTML route and a local asset
821+
link and verify the lane fails
822+
- **Edges:** `file://`-style static docs, generated HTML, root-relative vs
823+
relative links
824+
- **Fuzz/Stress:** n/a
825+
826+
**Blocked By:** none
827+
**Blocking:** none
828+
829+
**Est. Hours:** 4h
830+
**Expected Complexity:** ~140 LoC (validation wiring + docs + tests)
831+
832+
---
833+
834+
## T-10-8-18: Implementation-Backed Docs Claims Policy
835+
836+
**User Story:** As a maintainer, I want contributor guidance and lightweight
837+
checks around strong claims like `bit-exact`, `canonical`, and `deterministic`
838+
so that docs do not overstate what the code actually guarantees.
839+
840+
**Requirements:**
841+
842+
- R1: Define a short docs-claims checklist for implementation-backed guarantee
843+
language
844+
- R2: Identify especially sensitive claim words and the evidence expected for
845+
each
846+
- R3: Add a lightweight lint, review checklist, or equivalent guard for the
847+
most failure-prone phrases
848+
- R4: Document where stronger claims belong (specs, claim registers, crate
849+
docs) versus where contributor docs should stay conservative
850+
851+
**Acceptance Criteria:**
852+
853+
- [ ] AC1: A contributor-facing checklist exists for strong guarantee wording
854+
- [ ] AC2: The repo has at least one lightweight guard or review rubric for
855+
claim words like `bit-exact`, `canonical`, and `deterministic`
856+
- [ ] AC3: A representative overclaim is caught before PR review
857+
- [ ] AC4: Docs and spec surfaces describe the evidence expectation clearly
858+
859+
**Definition of Done:**
860+
861+
- [ ] Code reviewed and merged
862+
- [ ] Tests pass (CI green)
863+
- [ ] Documentation updated (if applicable)
864+
865+
**Scope:** Docs wording discipline, lightweight guardrails, and contributor
866+
guidance.
867+
**Out of Scope:** Proving every guarantee in the repo or replacing reviewer
868+
judgment with a perfect linter.
869+
870+
**Test Plan:**
871+
872+
- **Goldens:** n/a
873+
- **Failures:** Introduce a representative wording overclaim and verify the new
874+
checklist / guard catches it
875+
- **Edges:** Claim appears in roadmap docs, architecture docs, crate docs, or
876+
generated reference pages
877+
- **Fuzz/Stress:** n/a
878+
879+
**Blocked By:** none
880+
**Blocking:** none
881+
882+
**Est. Hours:** 3h
883+
**Expected Complexity:** ~80 LoC (docs + guard/checklist)
884+
885+
---
886+
887+
## T-10-8-19: Remove Committed Generated DAG Artifacts
888+
889+
**User Story:** As a maintainer, I want generated DAG outputs out of the main
890+
docs tree so that the repo keeps source-of-truth inputs, not churn-heavy baked
891+
artifacts.
892+
893+
**Requirements:**
894+
895+
- R1: Identify which DAG outputs are generated and should no longer live as
896+
committed source files
897+
- R2: Keep only the canonical DAG inputs and generation entrypoints in the repo
898+
- R3: Move generated DAG viewing/sharing to on-demand generation, CI artifacts,
899+
or another explicit publication path
900+
- R4: Update docs and validation so they no longer assume committed generated
901+
DAG outputs are the truth
902+
903+
**Acceptance Criteria:**
904+
905+
- [ ] AC1: Generated DAG artifacts are removed from the committed live docs
906+
surface
907+
- [ ] AC2: Contributors still have one documented way to generate or inspect
908+
the DAG outputs when needed
909+
- [ ] AC3: CI or release workflow still has a clear path for sharing generated
910+
DAG views when useful
911+
- [ ] AC4: Docs validation no longer depends on stale committed DAG outputs
912+
913+
**Definition of Done:**
914+
915+
- [ ] Code reviewed and merged
916+
- [ ] Tests pass (CI green)
917+
- [ ] Documentation updated (if applicable)
918+
919+
**Scope:** Generated dependency/task DAG artifacts and their publication path.
920+
**Out of Scope:** Removing the underlying DAG sources or DAG generation logic
921+
entirely.
922+
923+
**Test Plan:**
924+
925+
- **Goldens:** n/a
926+
- **Failures:** Remove a generated artifact and verify the documented
927+
generation/view path still works
928+
- **Edges:** Offline local viewing, CI artifact upload, docs links that used to
929+
target committed outputs
930+
- **Fuzz/Stress:** n/a
931+
932+
**Blocked By:** none
933+
**Blocking:** none
934+
935+
**Est. Hours:** 4h
936+
**Expected Complexity:** ~120 LoC (docs + workflow/tooling cleanup)

0 commit comments

Comments
 (0)