How karanpratapsingh/learn-go works
Project Type and Purpose
• This is a self-contained “Learn Go” course repository. It holds:
• Course content (README.md with Markdown lessons)
• Code examples (main.go and chapters in the README)
Key Components
a. Content Layer
• README.md (master course text)
• Additional chapter material embedded in Markdown
b. Code Examples
• main.go (demo program)
• Go toolchain for building/running examples
• Outputs (PNG/SVG) generated for documentation
d. Configuration & CI
• .github/ workflows (issue templates, funding, stale bot)
• GitHub Actions or Pages config for build/deploy
e. Distribution Channels (External Services)
• GitHub (source & Pages)
• Leanpub (ebook)
• Personal website (karanpratapsingh.com)
Relationships & Data Flows
• Upon push to GitHub:
• CI pipeline runs “go build” / “go fmt” on code examples
• Static site generator (or simple Jekyll/GitHub Pages) transforms Markdown + images into HTML
• Ebook (Leanpub) built from Markdown and asset bundle
• Learner accesses content via: GitHub website, personal site, or ebook
Architectural Patterns & Principles
• Single-repository content management (monorepo for all teaching assets)
• Content–build–deploy pipeline (similar to “docs as code”)
• Immutable artifacts: generated site and ebook are reproducible from source