diff --git a/CLAUDE.md b/CLAUDE.md index 9cf67a5..f4875bf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -37,6 +37,7 @@ chapters/ # SSG-agnostic tutorial content (canonical) 05-nested-repositories.md 06-expert-topics.md 07-playbook.md + recipes/ (17 recipe pages) 08-appendix.md 09-glossary.md assets/ diff --git a/chapters/07-playbook.md b/chapters/07-playbook.md new file mode 100644 index 0000000..4d43133 --- /dev/null +++ b/chapters/07-playbook.md @@ -0,0 +1,57 @@ +--- +title: "Playbook" +description: "Step-by-step recipes for common Git tasks — undoing changes, branching, merging, rebasing, stashing, tagging, and debugging." +section: "playbook" +order: 7 +--- + +## Overview + +This chapter is a quick-reference collection of recipes for common +Git tasks. Each recipe shows the problem, the commands to solve it, +and what to watch out for. + +For command syntax, see the [official Git reference](https://git-scm.com/docs). +For definitions, see [Glossary](09-glossary.md). + +## Everyday + +| Recipe | What you'll find | +|--------|-----------------| +| [Undoing Changes](playbook/undoing-changes.md) | Discard, unstage, reset, revert, and recover lost commits | +| [Diffing](playbook/diffing.md) | Unstaged, staged, between branches, commits, and files | +| [History](playbook/history.md) | Log formatting, filtering by author, date, and path | +| [Stashing](playbook/stashing.md) | Save and restore work in progress | + +## Branching and Merging + +| Recipe | What you'll find | +|--------|-----------------| +| [Branching](playbook/branching.md) | Create, delete, rename, and inspect branches | +| [Merging](playbook/merging.md) | Fast-forward, no-ff, squash, conflict resolution | +| [Rebasing](playbook/rebasing.md) | Linearize history and squash commits interactively | +| [Cherry-Picking](playbook/cherry-picking.md) | Apply individual commits across branches | + +## Remote + +| Recipe | What you'll find | +|--------|-----------------| +| [Remote Operations](playbook/remote-operations.md) | Push, pull, force push safely, sync forks | +| [Remote Management](playbook/remote-management.md) | Add, rename, remove remotes, switch URL, SSH setup | + +## Project Structure + +| Recipe | What you'll find | +|--------|-----------------| +| [Tagging](playbook/tagging.md) | Create, push, and delete annotated tags | +| [Submodules](playbook/submodules.md) | Add, clone, update, and remove submodules | +| [Subtrees](playbook/subtrees.md) | Add, pull, push, and remove subtrees | + +## Advanced + +| Recipe | What you'll find | +|--------|-----------------| +| [Selectors](playbook/selectors.md) | Tilde, caret, double-dot, triple-dot, reflog refs | +| [Hooks](playbook/hooks.md) | Pre-commit, commit-msg, sharing hooks, bypassing | +| [Debugging](playbook/debugging.md) | Bisect, blame, and search commit history | +| [Configuration](playbook/configuration.md) | Identity, defaults, aliases, and diagnostics | diff --git a/chapters/08-appendix.md b/chapters/08-appendix.md index 685095a..cd0bbc6 100644 --- a/chapters/08-appendix.md +++ b/chapters/08-appendix.md @@ -9,7 +9,7 @@ order: 8 This appendix contains reference material that supports the tutorial chapters — merge strategies, Git clients, external resources, and -notes. For step-by-step recipes, see the [Playbook](playbook/index.md). +notes. For step-by-step recipes, see the [Playbook](07-playbook.md). For command help, run `git help `. In this chapter you will learn: diff --git a/chapters/playbook/index.md b/chapters/playbook/index.md deleted file mode 100644 index 5a4847d..0000000 --- a/chapters/playbook/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Playbook" -description: "Step-by-step recipes for common Git tasks — undoing changes, branching, merging, rebasing, stashing, tagging, and debugging." -section: "playbook" -order: 7 ---- - -## Overview - -This chapter is a quick-reference collection of recipes for common -Git tasks. Each recipe shows the problem, the commands to solve it, -and what to watch out for. - -For command syntax, see the [official Git reference](https://git-scm.com/docs). -For definitions, see [Glossary](../09-glossary.md). - -## Everyday - -| Recipe | What you'll find | -|--------|-----------------| -| [Undoing Changes](undoing-changes.md) | Discard, unstage, reset, revert, and recover lost commits | -| [Diffing](diffing.md) | Unstaged, staged, between branches, commits, and files | -| [History](history.md) | Log formatting, filtering by author, date, and path | -| [Stashing](stashing.md) | Save and restore work in progress | - -## Branching and Merging - -| Recipe | What you'll find | -|--------|-----------------| -| [Branching](branching.md) | Create, delete, rename, and inspect branches | -| [Merging](merging.md) | Fast-forward, no-ff, squash, conflict resolution | -| [Rebasing](rebasing.md) | Linearize history and squash commits interactively | -| [Cherry-Picking](cherry-picking.md) | Apply individual commits across branches | - -## Remote - -| Recipe | What you'll find | -|--------|-----------------| -| [Remote Operations](remote-operations.md) | Push, pull, force push safely, sync forks | -| [Remote Management](remote-management.md) | Add, rename, remove remotes, switch URL, SSH setup | - -## Project Structure - -| Recipe | What you'll find | -|--------|-----------------| -| [Tagging](tagging.md) | Create, push, and delete annotated tags | -| [Submodules](submodules.md) | Add, clone, update, and remove submodules | -| [Subtrees](subtrees.md) | Add, pull, push, and remove subtrees | - -## Advanced - -| Recipe | What you'll find | -|--------|-----------------| -| [Selectors](selectors.md) | Tilde, caret, double-dot, triple-dot, reflog refs | -| [Hooks](hooks.md) | Pre-commit, commit-msg, sharing hooks, bypassing | -| [Debugging](debugging.md) | Bisect, blame, and search commit history | -| [Configuration](configuration.md) | Identity, defaults, aliases, and diagnostics | diff --git a/chapters/playbook/branching.md b/chapters/recipes/branching.md similarity index 100% rename from chapters/playbook/branching.md rename to chapters/recipes/branching.md diff --git a/chapters/playbook/cherry-picking.md b/chapters/recipes/cherry-picking.md similarity index 100% rename from chapters/playbook/cherry-picking.md rename to chapters/recipes/cherry-picking.md diff --git a/chapters/playbook/configuration.md b/chapters/recipes/configuration.md similarity index 100% rename from chapters/playbook/configuration.md rename to chapters/recipes/configuration.md diff --git a/chapters/playbook/debugging.md b/chapters/recipes/debugging.md similarity index 100% rename from chapters/playbook/debugging.md rename to chapters/recipes/debugging.md diff --git a/chapters/playbook/diffing.md b/chapters/recipes/diffing.md similarity index 100% rename from chapters/playbook/diffing.md rename to chapters/recipes/diffing.md diff --git a/chapters/playbook/history.md b/chapters/recipes/history.md similarity index 100% rename from chapters/playbook/history.md rename to chapters/recipes/history.md diff --git a/chapters/playbook/hooks.md b/chapters/recipes/hooks.md similarity index 100% rename from chapters/playbook/hooks.md rename to chapters/recipes/hooks.md diff --git a/chapters/playbook/merging.md b/chapters/recipes/merging.md similarity index 100% rename from chapters/playbook/merging.md rename to chapters/recipes/merging.md diff --git a/chapters/playbook/rebasing.md b/chapters/recipes/rebasing.md similarity index 100% rename from chapters/playbook/rebasing.md rename to chapters/recipes/rebasing.md diff --git a/chapters/playbook/remote-management.md b/chapters/recipes/remote-management.md similarity index 100% rename from chapters/playbook/remote-management.md rename to chapters/recipes/remote-management.md diff --git a/chapters/playbook/remote-operations.md b/chapters/recipes/remote-operations.md similarity index 100% rename from chapters/playbook/remote-operations.md rename to chapters/recipes/remote-operations.md diff --git a/chapters/playbook/selectors.md b/chapters/recipes/selectors.md similarity index 100% rename from chapters/playbook/selectors.md rename to chapters/recipes/selectors.md diff --git a/chapters/playbook/stashing.md b/chapters/recipes/stashing.md similarity index 100% rename from chapters/playbook/stashing.md rename to chapters/recipes/stashing.md diff --git a/chapters/playbook/submodules.md b/chapters/recipes/submodules.md similarity index 100% rename from chapters/playbook/submodules.md rename to chapters/recipes/submodules.md diff --git a/chapters/playbook/subtrees.md b/chapters/recipes/subtrees.md similarity index 100% rename from chapters/playbook/subtrees.md rename to chapters/recipes/subtrees.md diff --git a/chapters/playbook/tagging.md b/chapters/recipes/tagging.md similarity index 100% rename from chapters/playbook/tagging.md rename to chapters/recipes/tagging.md diff --git a/chapters/playbook/undoing-changes.md b/chapters/recipes/undoing-changes.md similarity index 100% rename from chapters/playbook/undoing-changes.md rename to chapters/recipes/undoing-changes.md diff --git a/docs/ONBOARDING.md b/docs/ONBOARDING.md index bc5ba4c..05b2d28 100644 --- a/docs/ONBOARDING.md +++ b/docs/ONBOARDING.md @@ -68,7 +68,8 @@ files for the web version. ``` 01-introduction.md 06-expert-topics.md -02-building-blocks.md playbook/ (17 recipe pages) +02-building-blocks.md 07-playbook.md + recipes/ (17 recipe pages) 03-branching-and-merging.md 08-appendix.md 04-remote-repositories.md 09-glossary.md 05-nested-repositories.md diff --git a/docs/PLAYBOOK.md b/docs/PLAYBOOK.md index 2bc46f7..a25010c 100644 --- a/docs/PLAYBOOK.md +++ b/docs/PLAYBOOK.md @@ -33,7 +33,7 @@ Operational reference for common tasks in tutorial-git. - Place exercises at the end of the chapter under `## Exercises` - Each exercise has: **Task**, **Steps** (numbered), **Verify** - Exercises within a chapter use the same lab repository -- Cross-topic recipes go in `chapters/playbook/` +- Cross-topic recipes go in `chapters/recipes/` ### 1.4 Adding quiz questions