Skip to content

docs(site): replace verification footers with Build, run, observe - #92

Merged
patterncatalyst merged 1 commit into
mainfrom
docs/cndp-footers-bro
Oct 23, 2026
Merged

patterncatalyst merged 1 commit into
mainfrom
docs/cndp-footers-bro

Conversation

@patterncatalyst

Copy link
Copy Markdown
Owner

Brings CNDP chapters to the same shape as the other sites: a ## Build, run, observe section and no reader-facing verification footer.

What changed

  • All 34 chapters: removed the trailing *Verification status: …* footer and banked each one verbatim in _plans/verification-log.md (the plans collection is output: false, so it isn't published).
  • Hands-on chapters (23): converted the existing ### Cross-check it yourself section to ## Build, run, observe — kept its run/observe prose and added the example's verify command (start one language's stack, run the language-agnostic verify.sh) plus what the script asserts, read from the real verify.sh (accurate per-chapter check counts, e.g. 8/8, 18/18, 29/29). The minikube/OpenShift appendices use their real k8s//oc sequences.
  • Conceptual chapters: kept their existing section; only the footer was removed.
  • CLAUDE.md convention note updated.

Content preserved

Net +167 lines (additive: footers moved to _plans, Build-run-observe added). No teaching content removed; a pre-existing duplicated sentence in ch03 is resolved.

Verification

  • grep for Verification status across _docs → 0. 23 ## Build, run, observe sections, no duplicates.
  • scripts/validate_site.py: 42 files, 0 errors. scripts/voice-scan.sh + global strict scan: 0 ban-tier. bundle exec jekyll build green; /plans/ unrendered.

Fourth CNDP PR, completing the site pass. The 6 language decks (binary deck_edit.py toolchain) remain as the agreed follow-on.

Across all 34 chapters, remove the reader-facing *Verification status:* footer
and bank it verbatim in _plans/verification-log.md (plans collection is
output: false, not published). On each hands-on chapter, convert the existing
"### Cross-check it yourself" section to "## Build, run, observe": keep its
run/observe prose and add the example's verify command (start one language's
stack, run the language-agnostic verify.sh) plus what that script asserts,
drawn from the real script. Conceptual chapters keep their existing section and
just lose the footer. The minikube and OpenShift appendices use their real
k8s/oc command sequences.

CLAUDE.md convention note updated to match. No content lost (net +167 lines,
additive). validate_site.py clean; voice-scan 0 ban-tier; Jekyll build green.
@patterncatalyst
patterncatalyst merged commit b36dbd5 into main Oct 23, 2026
16 checks passed
@patterncatalyst
patterncatalyst deleted the docs/cndp-footers-bro branch October 23, 2026 12:34
patterncatalyst added a commit that referenced this pull request Oct 23, 2026
Across all 34 chapters, remove the reader-facing *Verification status:* footer
and bank it verbatim in _plans/verification-log.md (plans collection is
output: false, not published). On each hands-on chapter, convert the existing
"### Cross-check it yourself" section to "## Build, run, observe": keep its
run/observe prose and add the example's verify command (start one language's
stack, run the language-agnostic verify.sh) plus what that script asserts,
drawn from the real script. Conceptual chapters keep their existing section and
just lose the footer. The minikube and OpenShift appendices use their real
k8s/oc command sequences.

CLAUDE.md convention note updated to match. No content lost (net +167 lines,
additive). validate_site.py clean; voice-scan 0 ban-tier; Jekyll build green.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant