GitHub in a Nutshell — Git & GitHub Reference Manual
A self-contained reference manual covering Git and GitHub from first principles through advanced internals — compiled from a structured training course, hands-on labs, and official documentation into one progressive resource.
Table of Contents
- What Is It?
- Who Is It For?
- What's Inside
- How It Was Built
- How to Use It
- Status & What's Next
- Manual Contents
1. What Is It?
GitHub in a Nutshell is a 29-chapter reference manual covering Git and GitHub from installation to CI/CD automation and storage internals. It was compiled from a 19-module training course, 13 hands-on lab projects, and gap chapters authored from official documentation — brought together into one structured, self-contained Markdown resource.
The problem it solves: Git knowledge is scattered. The official Git documentation (git-scm.com) covers the tool but not GitHub. GitHub's own documentation (docs.github.com) covers the platform but not Git fundamentals. Training courses give you exercises but not a reference you can look things up in later. This manual consolidates all three into a single document with a clear progression from beginner to advanced.
Key idea: Everything from "what is version control?" to "how does Git actually store objects on disk?" — in one place, in reading order.
2. Who Is It For?
The manual is structured for three entry points — pick the one that matches where you are.
Beginners
Start at Chapter 01 — Introduction to Version Control & Git. No prior Git or terminal experience assumed. Chapter 02 covers the shell commands you need before any Git command is introduced, so you can follow every example from the first page.
Recommended path: Parts 1–4 (Chapters 01–22) — from VCS concepts through collaborating on GitHub with pull requests and branch protection.
Intermediate users
Already comfortable with basic commits and branches? Start at Part 3 — Branching & History Management (Chapter 11) or Part 4 — GitHub & Collaboration (Chapter 17).
Useful standalone chapters at this level: rebasing (Ch 13), interactive rebase (Ch 14), undoing changes (Ch 08), inspecting history (Ch 10).
Advanced / curious
Part 7 — Under the Hood (Chapters 28–29) explains the Git object model — how blobs, trees, and commits are stored as SHA1-hashed objects on disk. Useful for understanding what Git is actually doing when you run everyday commands.
3. What's Inside
| Part | Chapters | Topics |
|---|---|---|
| 1 — Getting Started | Ch 01–04 | Version control concepts, shell primer, Git installation and configuration, GitHub authentication (SSH keys, Personal Access Tokens, gh CLI) |
| 2 — Core Workflow | Ch 05–10 | Creating repositories, tracking files and file states, .gitignore, undoing changes, stashing, inspecting history (log, blame, bisect, diff) |
| 3 — Branching & History | Ch 11–16 | Branches and HEAD, merging strategies, rebasing, interactive rebase, tags and semantic versioning, detached HEAD state |
| 4 — GitHub & Collaboration | Ch 17–22 | GitHub overview and remote repositories, push/fetch/pull, forks and open-source contribution, pull requests, branch protection and code review workflows, GitHub Issues and project management |
| 5 — Automation | Ch 23–25 | Git hooks (client-side and server-side), GitHub Actions and CI/CD pipelines, GitHub Pages (static sites, Jekyll, React) |
| 6 — Workflows & Best Practices | Ch 26–27 | GitFlow, trunk-based development, feature branch workflow; Git aliases and productivity tips |
| 7 — Under the Hood | Ch 28–29 | Git object model (blobs, trees, commit objects), SHA1 hashing and content-addressed storage, how Git actually stores your history |
| Appendix | A–C | Git Submodules, Git LFS (Large File Storage), signed commits and GPG |
4. How It Was Built
| Source | What it contributed |
|---|---|
| Vault notes | 107 notes converted from 15 PDF training slide decks — the core narrative content for most chapters |
| Hands-on labs | 13 lab projects — practical examples and exercises woven into relevant chapters |
| Gap chapters | Chapters authored from git-scm.com and docs.github.com where training materials didn't cover a topic (authentication, CI/CD, workflows) |
Each chapter notes its source — vault, lab, or gap — so the origin of any section is transparent. The shell primer in Chapter 02 was added specifically to make the manual accessible to readers unfamiliar with the terminal.
5. How to Use It
Sequential read: Parts 1–4 (Chapters 01–22) form a complete beginner-to-collaborator progression. Read in order for the full learning path.
Reference mode: Each chapter is self-contained. Jump directly to the topic you need using the index below — no need to read preceding chapters.
Platform notes: All shell examples work on Git Bash (Windows), bash, and zsh (macOS/Linux). Where platform behaviour differs, the chapter notes it.
6. Status & What's Next
| Count | Notes | |
|---|---|---|
| Complete | 20 of 29 chapters | Parts 1–4 fully drafted and ready to use |
| In progress | 9 chapters | Parts 5–7 — automation, workflows, and internals |
| Planned | 3 appendix chapters | Submodules, Git LFS, signed commits |
7. Manual Contents
Part 1 — Getting Started
| Chapter | Title |
|---|---|
| Ch 01 | Introduction to Version Control & Git |
| Ch 02 | Shell Commands Primer |
| Ch 03 | Installing & Configuring Git |
| Ch 04 | GitHub Authentication (SSH, PATs, gh CLI) |
Part 2 — Core Git Workflow
| Chapter | Title |
|---|---|
| Ch 05 | Creating a Repository & Basic Operations |
| Ch 06 | Tracking Files & File States |
| Ch 07 | Ignoring Files (.gitignore) |
| Ch 08 | Undoing Changes |
| Ch 09 | Stashing |
| Ch 10 | Inspecting History (log, blame, bisect, diff) |
Part 3 — Branching & History Management
| Chapter | Title |
|---|---|
| Ch 11 | Branches and HEAD |
| Ch 12 | Merging Branches |
| Ch 13 | Rebasing |
| Ch 14 | Interactive Rebase |
| Ch 15 | Tags & Semantic Versioning |
| Ch 16 | Detached HEAD |
Part 4 — GitHub & Collaboration
| Chapter | Title |
|---|---|
| Ch 17 | GitHub Overview & Remote Repositories |
| Ch 18 | Push, Fetch & Pull |
| Ch 19 | Forks & Contributing to Open Source |
| Ch 20 | Pull Requests |
| Ch 21 | Branch Protection & Code Review Workflows |
| Ch 22 | GitHub Issues & Project Management |
Part 5 — Automation & Deployment
| Chapter | Title |
|---|---|
| Ch 23 | Git Hooks |
| Ch 24 | GitHub Actions & CI/CD |
| Ch 25 | GitHub Pages |
Part 6 — Workflows & Best Practices
| Chapter | Title |
|---|---|
| Ch 26 | Git Workflows (GitFlow, Trunk-based, Feature Branch) |
| Ch 27 | Git Aliases & Productivity Tips |
Part 7 — Under the Hood
| Chapter | Title |
|---|---|
| Ch 28 | Git Object Model: Blobs, Trees & Commits |
| Ch 29 | SHA1, Hashing & Object Storage Internals |
Appendix
| Chapter | Title |
|---|---|
| App A | Git Submodules |
| App B | Git LFS (Large File Storage) |
| App C | Signed Commits & GPG |