How chiphuyen/aie-book works
Project type and purpose
• This is not a traditional software application but a documentation project (a technical book and associated resources).
• The repo contains the source markdown files for chapters, tables of contents, summaries, case studies, prompts, resources, misalignment notes, an appendix, and assets (cover images). It also includes a Jupyter notebook under scripts/ as a “fun tool” for generating heatmaps of model conversations. The ToC.pdf suggests a build‐to‐PDF step.
File structure
• Top-level markdown files: the book’s chapters and auxiliary documents (ToC, summaries, resources, case studies, etc.).
• assets/: cover art and any figures used in the markdown.
• scripts/ai-heatmap.ipynb: an independent notebook for generating conversation heatmaps.
• No explicit build or CI configuration files are present, implying a simple build process (e.g., Pandoc, make, or O’Reilly’s internal toolchain) invoked manually or via a minimal CI script.
README for additional insights
• The README positions this repo as a living set of book artifacts and resources, to be updated over time.
• Mentions distribution channels (Amazon, O’Reilly, Kindle), but no direct code for website hosting—likely published externally or via GitHub Pages once built.
Elements
• Clear labels for each component (e.g., “GitHub Repo,” “Build Server,” “Artifact Store,” “Amazon/O’Reilly”)
• Rectangles for compute components (Build System, Notebook Executor)
• Clouds for external services (Amazon, O’Reilly, GitHub Pages)
Detailed capture of essential elements
• Even though this is “just” markdown, separate source content, media assets, build logic, and distribution.
• How the Jupyter notebook sits alongside content but feeds into the build only when generating special outputs.