About this site
This site follows the Diátaxis framework. That is a way to organize documentation so people can find what they need.
The four types of docs
Section titled “The four types of docs”-
Tutorial — For learning. You follow steps from start to finish. You do the steps yourself. Example: Getting started.
-
How-to guide — For a task. You have a goal. The guide shows you how to do that one thing. Example: How do I put my project on GitHub?.
-
Reference — For looking things up. No story. Just facts and commands. Example: Cheat sheet and each command page under Reference.
-
Explanation — For understanding. It explains ideas and how things fit together. Example: What is Git? and How the commands fit together.
Why we write in simple words
Section titled “Why we write in simple words”We write so that anyone can follow. That means:
- Short sentences.
- Simple words (we avoid jargon, or we explain it once).
- One idea per sentence.
- Concrete examples.
You get a complete reference: tutorials, task-based guides, and a full command reference. You also get understandable explanations so the big picture is clear.
Acknowledgments and thanks
Section titled “Acknowledgments and thanks”Steve Bennett wrote “10 things I hate about Git” in 2012. That article names why Git is hard to learn: too many concepts, inconsistent syntax, documentation written for experts, and simple tasks that need too many commands. It’s a major reason this site exists. We want a sensible reference that answers those criticisms — human words, common commands first, no maze.
We don’t copy his diagrams or his text here; his article is on his blog. We do reuse his core arguments in our own words in Why Git feels hard, and we’re grateful for his work. Thank you, Steve.
This site is built with Starlight — the documentation theme for Astro. Starlight gives us the sidebar, search, and clean layout you see here. Thank you to the Astro team and Starlight contributors.