mirror of
https://github.com/logos-blockchain/logos-blockchain-testing.git
synced 2026-01-02 05:13:09 +00:00
2.6 KiB
2.6 KiB
Book → Repo Sync Review (2025-12-20)
Reviewed against git rev-parse HEAD at the time of writing, plus local working tree changes.
Checks Run
mdbook build bookmdbook test bookcargo build -p doc-snippets- Verified
book/src/SUMMARY.mdcovers all pages inbook/src/(no orphaned pages) - Verified all
scripts/...paths referenced from the book exist - Compared
NOMOS_*environment variables used inscripts/,testing-framework/, andexamples/vs.book/src/environment-variables.md
Findings / Fixes Applied
book/src/environment-variables.mdwas not a complete reference: it missed multipleNOMOS_*variables used by the repo (scripts + framework). Added the missing variables and corrected a misleading note aboutRUST_LOGvs node logging.book/src/running-examples.md“Quick Smoke Matrix” section didn’t reflect currentscripts/run/run-test-matrix.shflags. Added the commonly used options and clarified the relationship toNOMOS_SKIP_IMAGE_BUILD.book/src/part-iv.mdexisted but was not inbook/src/SUMMARY.md. Removed it so the rendered book doesn’t silently diverge from the filesystem.mdbook test bookwas failing because:- Many Rust examples were written as
```rust(doctested by default) but depend on workspace crates; they aren’t standalone doctest snippets. - Several unlabeled code blocks (e.g. tree/log output) were treated as Rust by rustdoc.
- Updated code fences to
```rust,ignorefor non-standalone Rust examples and to```textfor non-Rust output blocks somdbook test booksucceeds.
- Many Rust examples were written as
Pages Reviewed (No Skips)
All pages under book/src/ currently included by book/src/SUMMARY.md:
annotated-tree.mdapi-levels.mdarchitecture-overview.mdauthoring-scenarios.mdbest-practices.mdchaos.mdci-integration.mdcustom-workload-example.mddesign-rationale.mddsl-cheat-sheet.mdenvironment-variables.mdexamples-advanced.mdexamples.mdextending.mdfaq.mdglossary.mdinternal-crate-reference.mdintroduction.mdlogging-observability.mdnode-control.mdoperations-overview.mdpart-i.mdpart-ii.mdpart-iii.mdpart-v.mdpart-vi.mdprerequisites.mdproject-context-primer.mdquickstart.mdrunners.mdrunning-examples.mdrunning-scenarios.mdscenario-builder-ext-patterns.mdscenario-lifecycle.mdscenario-model.mdtesting-philosophy.mdtopology-chaos.mdtroubleshooting.mdusage-patterns.mdwhat-you-will-learn.mdworkloads.mdworkspace-layout.md