How chungpv/go-advanced works
Main components
• Documentation Content – the chapters that form the curriculum. Represent these with nodes for each major chapter (e.g., "ch1-basic", "ch2-cgo", "ch3-rpc", "ch4-web", "ch5-distributed-system", "ch6-best-practices").
• Documentation Build and Formatting – the “docs”, “docs/gitbook”, and "SUMMARY.md" files that are used to generate HTML, PDF, and possibly other static outputs. Indicate the workflow from markdown source to HTML output via GitBook.
• Code Examples – the “examples”, “docs/examples” directories (and deeper nested directories) that provide runnable code samples for each chapter. Separate these from the textual content but show the integration (for instance, “Examples” often accompany the respective chapter).
Relationships and data flows
• Examples directories with the corresponding chapter nodes to show that practical code samples support the academic content.
• Directional flows from the GitHub contribution module (issue templates in .github and repository metadata) to the overall project, indicating how community feedback or contributions are integrated.
• External resources like the official Golang website or external courses used as references (listed in the README) as ancillary components.
Architectural patterns and design principles
• Modularity: Each chapter is self-contained, forming a module within the overall learning path.
• Separation of Concerns: The project cleanly separates “content” (tutorial chapters and documentation) from “code examples” and “static build assets” (docs, images, pdfs, GitBook).
• Extensibility: The presence of multiple nested directories and a clear GitHub contribution workflow shows the design anticipates community extension and updates.
Relevant technologies
• Golang: The examples are written in Go and illustrate advanced programming topics.
• GitBook: Used for converting markdown documentation into styled websites and PDF outputs.
• Git and GitHub: For version control, issues, and managing contributions.
• Supporting frameworks or libraries may be indirectly referenced through example code (CGO, RPC, Web programming, distributed systems patterns).
• Labels for each major folder and functional area: “Content Modules (ch1-basic, ch2-cgo, …)”, “Documentation Outputs (docs, GitBook)”, “Examples”, “Assets (images, resource)”, and “Contribution Infrastructure (.github, README)” etc.