Summary
Umbrella tracker for the remaining lower-severity documentation drift found during the multi-pass docs-correctness review (PR #1528). #1528 fixed the P1s and the bulk of P2 prose; this issue captures the long tail that remains, to be cleaned up incrementally rather than growing #1528 further.
Remaining items (P2/P3)
Stale bundle-layout examples (current output uses numbered NNN-<component>/ dirs, root checksums, per-component install.sh, cluster-values.yaml, no undeploy.sh):
docs/user/api-reference.md (~L487), docs/user/tutorial.md (~L76), README.md (~L97), and several demos/*.
data-flow.md architecture drift:
- Claims snapshot fields (K8s version, images, kernel, OS version) become recipe criteria; criteria only contain service/accelerator/intent/OS-family/platform/node-count.
- Describes a parallel bundler registry and a nonexistent
ScriptData type.
Contributor-guide correctness:
tests.md recommends Cobra's cmd.SetOut in an urfave/cli v3 codebase.
- "fail-fast"/"silently skipped" descriptions that contradict fail-closed behavior;
make qualify described as checking BOM freshness; coverage decrease called "blocking" rather than "flagged"; / described as bypassing middleware; stdout described as the CTRF message.
Demos non-runnable:
demos/end-to-end-cli.md uses removed recipe --criteria.
demos/bundle-attestation* modifies an unnumbered bundle path that no longer exists.
Other user-facing:
- Impossible
GPU.info.type constraint path; incorrect saved-recipe --data persistence semantics; binary SBOMs described as embedded rather than separate GoReleaser artifacts; a wget invoked inside a distroless server image.
One live 404: demos/cuj2-demo.md (~L306) links to nonexistent docs/conformance/cncf/submission; surrounding component count + bundle layout also stale.
Related
Summary
Umbrella tracker for the remaining lower-severity documentation drift found during the multi-pass docs-correctness review (PR #1528). #1528 fixed the P1s and the bulk of P2 prose; this issue captures the long tail that remains, to be cleaned up incrementally rather than growing #1528 further.
Remaining items (P2/P3)
Stale bundle-layout examples (current output uses numbered
NNN-<component>/dirs, rootchecksums, per-componentinstall.sh,cluster-values.yaml, noundeploy.sh):docs/user/api-reference.md(~L487),docs/user/tutorial.md(~L76),README.md(~L97), and severaldemos/*.data-flow.md architecture drift:
ScriptDatatype.Contributor-guide correctness:
tests.mdrecommends Cobra'scmd.SetOutin an urfave/cli v3 codebase.make qualifydescribed as checking BOM freshness; coverage decrease called "blocking" rather than "flagged";/described as bypassing middleware; stdout described as the CTRF message.Demos non-runnable:
demos/end-to-end-cli.mduses removedrecipe --criteria.demos/bundle-attestation*modifies an unnumbered bundle path that no longer exists.Other user-facing:
GPU.info.typeconstraint path; incorrect saved-recipe--datapersistence semantics; binary SBOMs described as embedded rather than separate GoReleaser artifacts; awgetinvoked inside a distroless server image.One live 404:
demos/cuj2-demo.md(~L306) links to nonexistentdocs/conformance/cncf/submission; surrounding component count + bundle layout also stale.Related