docs(book): rewrite all chapters as full guided tutorials#33
Merged
Conversation
Transforms every teaching chapter from "by example" into a complete, teach-from-zero guided tutorial, and republishes the dist. Each chapter now opens with concrete learning objectives and a "Concepts you will meet" key-terms section, introduces every concept from first principles before using it (key-term callouts), walks the reader through explicit numbered Steps with a "what just happened" after each, adds verifiable Checkpoints, and closes with a Recap, hands-on Exercises, and a "Where to go next" pointer. - 26 chapters rewritten (01–22 incl. 04a/04b/06a/20a); source grew ~13k → ~21k lines, PDF 2.9 MB → 4.3 MB. - Every code example re-verified against the shipped crates/samples (~370 fences checked). Real drift fixed along the way, e.g.: StaticSource::new takes a HashMap (was an array — wouldn't compile); the profile env layer is FIREFLY_*, not LUMEN_*; Lumen's Ledger is a #[bean] factory in LumenBeans, not a #[derive(Service)]; version 26.6.24 → 26.6.28; a broken ./05-reactive.md link → 05-reactive-model.md. - Consistency-audited: no broken intra-book links, callouts use only the Note/Tip/Warning/Design-note leaders, RFC 9457 (not 7807) and "Command/Query Responsibility Segregation" used uniformly, the previously truncated layered-microservices chapter completed (223 → 926 lines). - Designed inline SVG diagrams preserved; dist (PDF + EPUB) regenerated. Docs-only; no crate or version change. (English is the canonical source; a Spanish edition follows.)
ancongui
added a commit
that referenced
this pull request
Jun 16, 2026
…mplos" (#36) A full Spanish translation of the book, built from the same source tree and sharing the openers + the new designed diagrams. English remains canonical; the ES edition tracks it. - book-es.yaml: the Spanish manifest (src_dir: src-es, language es, localized labels Capítulo/Apéndice/Contenido, output names *-es.{pdf,epub}, Spanish part/chapter/front titles). Build: `BOOK_CONFIG=book-es.yaml docs/book/build-book.sh`. - src-es/: all 34 files translated to professional es-ES (28 chapters/appendix/ glossary + 6 front-matter). Code blocks, inline SVG figures, and intra-book links preserved verbatim (only figcaptions + prose translated); the build localizes callout labels (Note→Nota, Tip→Consejo, Warning→Advertencia). Audited for fidelity: code byte-identical, figures intact, links consistent. - dist: firefly-rust-by-example-es.{pdf,epub} (PDF ~4.5 MB). - CI: the Release workflow now verifies + attaches BOTH editions on a tag, so every release ships the English and Spanish books. Built on the i18n-capable book pipeline (#34); inherits the guided-tutorial content (#33) and the designed diagram system (#35). Co-authored-by: Andrés Contreras Guillén <ancongui@Andress-MacBook-Pro-2.local>
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
1 participant
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.
Transforms every teaching chapter into a complete, teach-from-zero guided tutorial (learning objectives, concepts-from-first-principles with key-term callouts, explicit numbered Steps with 'what just happened', checkpoints, recap, exercises, 'where to go next') and republishes the dist.
StaticSource::newHashMap,FIREFLY_*profile env prefix, Lumen'sLedger#[bean]factory, version 26.6.28, a broken reactive link).Docs-only. English is canonical; a Spanish edition follows.