You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A complete pocket guide for data, AI and deployment work: from the terminal and Git to LLM apps, agents and cloud deployment. Numbered from basic to advanced; every guide explains what a tool is, why it exists, how it works (with mental-model diagrams) and when to use each command.
New here? Start with 00 - Big Picture (how everything connects, the journey of a request through an AI app, learning paths), then 01 - Core Concepts (the basic vocabulary: packages, APIs, SDKs, configuration, reading errors).
Practice: every guide ends with a Try It section (exercises with hidden solutions), and examples/ has runnable, tested mini-projects: LLM basics, a tool-using agent, a RAG chatbot API and an MCP server.
When to make a template, GitHub template repos, Copier (questions, placeholders, update), Cookiecutter, testing templates in CI
What's in This Repository
pocket-guide/
README.md this page: the index of all guides
guides/ every guide, 00_big-picture.md ... 99_quick-reference.md
examples/ runnable mini-projects with tests (no API key needed)
llm_basics/ one call, streaming, structured output
tool_agent/ tool definitions and a manual agent loop
docs_chatbot/ RAG chatbot: FastAPI, vector index, evals, Docker (the capstone code)
mcp_server/ MCP server exposing document search
templates/ starting points to copy into your own projects
fullstack-microservices/ Python services in Docker + React frontend + Nginx proxy
service-template/ Copier template that adds a new service to the starter
tools/ scripts: doc checks, navigation, glossary, website build
site_assets/ website stylesheet (extra.css)
mkdocs.yml website configuration and page order
requirements-docs.txt packages needed to build the website
lychee.toml link checker settings
.markdownlint-cli2.jsonc Markdown style rules
.github/workflows/ CI: doc checks, link check, examples, templates, website deploy
What each script checks or generates, building the website locally, CI workflows
Conventions
File names: guides/NN_topic.md (two-digit number, lowercase, hyphens), ordered from basic to advanced.
Each Introduction starts with Before you start: what to read first, the problem the tool solves, how it was done before, and an everyday analogy.
Each guide opens with an Introduction: what the tool is, why we use it, a mental model, key terms and where it fits with the other guides.
Each Introduction ends with an Official docs table: the tool's home page and key reference pages for the latest information.
Then a numbered Contents list; sections are numbered to match.
Section 0. Flags and Parameters breaks a sample command into its parts and explains every flag / parameter used in that guide.
Each section opens with a short summary: what it is, how it works, and when you would use it.
Previous / Next links at the top and bottom of every guide follow the reading order (generated by tools/build_nav.py).
Commands have a short comment on the right explaining what they do.
Most guides end with a Troubleshooting table of common errors and fixes.
Each guide shows a Last verified date and ends with a Try It exercise section.
Quality checks run in CI: tools/check_docs.py (structure, links between guides, anchors), markdownlint, a weekly external link check, the site build and the example tests.
Fast-moving tools (LLM models, agent frameworks, cloud services) change often: the concepts are stable, but check the Official docs links in each guide for exact current versions and names.
About
Cheat sheets covering Python, NumPy, Pandas, and Markdown for quick reference and learning.