Skip to content

Commit 7a1cefe

Browse files
authored
Merge pull request #163 from braboj/docs/update-project-docs
docs: update project docs after 360 audit
2 parents 6e6b750 + e872c77 commit 7a1cefe

3 files changed

Lines changed: 48 additions & 3 deletions

File tree

docs/ONBOARDING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ npm run dev
4040

4141
Open `http://localhost:4321/tutorial-git/` — the Astro dev server should start. All 9
4242
chapters are wired as single-page sections. The site is deployed to
43-
`braboj.github.io/tutorial-git/` via GitHub Actions.
43+
`braboj.me/tutorial-git/` via GitHub Actions.
4444

4545

4646
## 4. Key files
@@ -68,7 +68,7 @@ files for the web version.
6868

6969
```
7070
01-introduction.md 06-expert-topics.md
71-
02-building-blocks.md 07-playbook.md
71+
02-building-blocks.md playbook/ (17 recipe pages)
7272
03-branching-and-merging.md 08-appendix.md
7373
04-remote-repositories.md 09-glossary.md
7474
05-nested-repositories.md

docs/PLAYBOOK.md

Lines changed: 1 addition & 1 deletion
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-topic recipes go in `07-playbook.md`
36+
- Cross-topic recipes go in `chapters/playbook/`
3737

3838
### 1.4 Adding quiz questions
3939

docs/dev-journal.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,3 +280,48 @@ Architecture overview and chronological session log for tutorial-git.
280280

281281
**Open issues:**
282282
- #106, #109, #110, #113, #114, #116#119, #122, #127, #131#133, #135, #140, #147
283+
284+
### 2026-04-25 — 360 audit, issue triage, nav automation spike
285+
286+
**Tool:** Claude Code (Opus 4.6)
287+
288+
**Key changes:**
289+
- Full 360 audit: content, Astro site, assets, issue tracker
290+
- Simplified label system from 22 labels to 8 (P0–P4 priority + bug/docs/feature)
291+
- Triaged all 29 open issues with priority labels
292+
- Created nav automation spike in imbra-spikes (`cross-cutting/SPIKE-TUTORIAL-NAV-AUTOMATION.md`)
293+
- Updated ONBOARDING.md and PLAYBOOK.md to reflect current project state
294+
295+
**Audit findings:**
296+
- Content: all image refs and cross-chapter links valid; glossary missing "worktree"
297+
- Astro site: well-built; dark mode code blocks don't adapt; base path hardcoded
298+
- Assets: 1 orphaned drawio, 1 orphaned PNG, 16 .bkp temp files
299+
- README: broken ch07 link, stale copy instructions, domain mismatch
300+
- Issue tracker: 23 issues created in bulk with no priority — now triaged
301+
302+
**Issues created:**
303+
- #151 — Add favicon
304+
- #152 — Add Open Graph meta tags
305+
- #153 — Split substantial playbook recipes into standalone pages
306+
- #154 — Improve thin playbook recipes in rebasing, stashing, and submodules
307+
- #155 — Review nested repositories chapter
308+
- #156 — Rename playbook index to 07-playbook.md
309+
- #157 — Fix outdated README
310+
- #158 — Add worktree to glossary
311+
- #159 — Fix dark mode styling for code blocks
312+
- #160 — Make base path portable for domain migration
313+
- #161 — Add lazy loading for images
314+
- #162 — Clean up orphaned assets and drawio backups
315+
316+
**Decisions:**
317+
- Analytics: GSC for tutorials (free), Plausible for Wuseria
318+
- Playbook split rule: own page only if recipe has command + explanation + gotcha
319+
- Sequence #154 before #153 (improve content before splitting)
320+
- Sequence #156 before #157 (create file before fixing README link)
321+
322+
**Open issues:**
323+
- P0: #156, #157, #162
324+
- P1: #153, #154, #155, #158
325+
- P2: #110, #151, #152, #159, #161
326+
- P3: #135, #160
327+
- P4: #106, #109, #113, #114, #116#119, #122, #127, #131#133, #140, #147

0 commit comments

Comments
 (0)