Repository navigation
docs: chapter-template retrofit + readability/voice pass (all chapters) - #14
Merged
Merged
Conversation
…ll chapters
Bring the DataMesh Python site up to the API-patterns house chapter
template and make it read as follow-along material for engineers,
matching the Quarkus pilot (PR #62 on the Quarkus repo).
- Add `## Learning objectives` (top), `## Why this matters` (over the
existing intro), and `## For deeper coverage` (final section) to all
13 _docs chapters.
- Moderate readability restructure: split walls of text, add signposting
subheadings so steps read in build order. All code, commands,
`{% include %}` figures, captions, and verified output preserved verbatim.
- Extra follow-along pass on the minikube substrate (ch02) and the
OpenShift/CRC appendix (ch11); commands cross-checked against the
real scripts.
- Professional-voice pass: cleared all non-"capstone" ban-tier tics
(honest/deliberately/worth-noting/load-bearing/for-free/etc.);
forbidden-syntax, cross-references, liquid-collisions all clean;
jekyll build green.
Deeper-coverage citations use real hub reading-list titles and canonical
docs only; no invented ISBNs or URLs. The word "capstone" is intentionally
left for a separate docs+code rename follow-up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Brings the DataMesh Python site up to the API-patterns house chapter template and makes it read as follow-along material for engineers. Mirrors the Quarkus pilot (companion PR on
datamesh-reference-arch-quarkus).Changes (all 13
_docs/chapters)## Learning objectivesat the top — "By the end of this chapter you can:" + 3–5 verb-led bullets.## Why this mattersheading over each chapter's existing intro.## For deeper coverageas the final section (after any closing section such as "Where to go from here"), citing only real hub reading-list titles and canonical docs — no invented ISBNs/URLs.###subheadings so steps read in build order. Every code block,{% include %}figure, caption, and recorded output preserved verbatim; front matter untouched.Verification
For deeper coveragelast.scripts/forbidden-syntax.sh,scripts/check-cross-references.sh(79 links),scripts/check-liquid-collisions.sh→ all clean.lgtm-professional-voice→ no non-"capstone" ban-tier remain (one figure caption preserved verbatim).bundle exec jekyll build→ clean.Deliberately out of scope here
The word "capstone" is left untouched throughout. It is both house-voice ban-tier and a real code identifier (Helm chart
charts/capstone, proto packagecapstone, scriptsbootstrap-capstone.sh/setup-capstone-profile.sh,-capstone-*.svgfigures). A full docs+code rename is planned as a separate follow-up so prose and code stay consistent.