Skip to content

Commit e10d8bd

Browse files
brabojclaude
andcommitted
docs: update ONBOARDING and PLAYBOOK for current structure
ONBOARDING: add chapter list and difficulty tiers PLAYBOOK: fix playbook reference (05→07), add CLI export pipeline, use git switch instead of git checkout Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 140c0bd commit e10d8bd

2 files changed

Lines changed: 25 additions & 5 deletions

File tree

docs/ONBOARDING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,22 @@ is not yet wired to `chapters/`, so content may be placeholder.
5252
## 5. Project context
5353

5454
tutorial-git is part of the **Code with Branko** tutorial platform. It
55-
teaches Git from scratch — aimed at beginners with no prior experience.
55+
teaches Git across three difficulty tiers — Beginner (chapters 1-2),
56+
Advanced (chapters 3-5), and Expert (chapter 6). Chapters 7-9 are
57+
reference material (playbook, appendix, glossary).
5658

5759
The content lives in `chapters/` as plain Markdown, independent of any
5860
static site generator. The Astro site in `astro-site/` consumes these
5961
files for the web version.
6062

63+
```
64+
01-introduction.md 06-expert-topics.md
65+
02-building-blocks.md 07-playbook.md
66+
03-branching-and-merging.md 08-appendix.md
67+
04-remote-repositories.md 09-glossary.md
68+
05-subprojects.md
69+
```
70+
6171
Chapter structure, writing conventions, and figure style rules are
6272
documented in `CLAUDE.md`. Quality conventions (git workflow, docs,
6373
code style) are inherited from the `docs/solid-ai-templates/` submodule.

docs/PLAYBOOK.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Operational reference for common tasks in tutorial-git.
3333
- Place exercises at the end of the chapter under `## Exercises`
3434
- Each exercise has: **Task**, **Steps** (numbered), **Verify**
3535
- Exercises within a chapter use the same lab repository
36-
- Cross-chapter exercises go in `05-playbook.md`
36+
- Cross-topic recipes go in `07-playbook.md`
3737

3838
### 1.4 Adding quiz questions
3939

@@ -55,6 +55,16 @@ Operational reference for common tasks in tutorial-git.
5555

5656
### 2.2 Exporting as PNG
5757

58+
**CLI (recommended for batch export):**
59+
60+
```bash
61+
DRAWIO="/c/Program Files/draw.io/draw.io.exe"
62+
"$DRAWIO" --export --format png --scale 2 --transparent \
63+
--output assets/images/<name>.png assets/drawio/<name>.drawio
64+
```
65+
66+
**Manual (single diagram):**
67+
5868
1. Open the `.drawio` file in draw.io
5969
2. File → Export as → PNG
6070
3. Settings: transparent background, 2x scale
@@ -105,8 +115,8 @@ automatically.
105115
### 4.1 Branch and commit
106116

107117
```bash
108-
git checkout main && git pull
109-
git checkout -b docs/chapter-name
118+
git switch main && git pull
119+
git switch -c docs/chapter-name
110120
# ... make changes ...
111121
git add chapters/NN-slug.md
112122
git commit -m "docs: description of change"
@@ -122,7 +132,7 @@ git push -u origin docs/chapter-name
122132
### 4.3 After merge
123133

124134
```bash
125-
git checkout main && git pull
135+
git switch main && git pull
126136
git branch -d docs/chapter-name
127137
git push origin --delete docs/chapter-name
128138
```

0 commit comments

Comments
 (0)