Skip to content

Commit 986860c

Browse files
authored
Merge pull request #104 from braboj/docs/session-3-wrapup
Session 3 wrap-up: update docs
2 parents 798db9b + 2b16184 commit 986860c

3 files changed

Lines changed: 58 additions & 8 deletions

File tree

docs/ONBOARDING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ How to set up and start contributing to tutorial-git.
66
## 1. Prerequisites
77

88
- Git 2.23+ (for `git switch` / `git restore`)
9-
- Node.js 18+ and npm
9+
- Node.js 22+ and npm
1010
- A text editor with Markdown support
1111
- draw.io desktop (for editing diagrams)
1212

@@ -16,9 +16,14 @@ How to set up and start contributing to tutorial-git.
1616
```bash
1717
git clone --recurse-submodules https://github.com/braboj/tutorial-git.git
1818
cd tutorial-git
19-
cd astro-site && npm install && cd ..
19+
cd astro-site && npm install
20+
ln -s ../../../assets src/content/assets # image symlink (Linux/macOS)
21+
cd ..
2022
```
2123

24+
On Windows, the symlink is created as a directory copy automatically.
25+
The symlink is gitignored — each developer creates it locally.
26+
2227
If you cloned without `--recurse-submodules`:
2328

2429
```bash
@@ -33,8 +38,9 @@ cd astro-site
3338
npm run dev
3439
```
3540

36-
Open `http://localhost:4321` — the Astro dev server should start. The site
37-
is not yet wired to `chapters/`, so content may be placeholder.
41+
Open `http://localhost:4321` — the Astro dev server should start. All 9
42+
chapters are wired as single-page sections. The site is deployed to
43+
`braboj.github.io/tutorial-git/` via GitHub Actions.
3844

3945

4046
## 4. Key files

docs/PLAYBOOK.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,18 +96,30 @@ cd astro-site
9696
npm run dev # http://localhost:4321
9797
```
9898

99-
### 3.2 Building for production
99+
### 3.2 Syncing chapters to the Astro site
100+
101+
Chapters in `chapters/` are the canonical source. The Astro site reads
102+
copies from `astro-site/src/content/docs/`. After editing a chapter:
103+
104+
1. Copy the file: `cp chapters/NN-slug.md astro-site/src/content/docs/slug.md`
105+
2. Fix cross-references — replace `(NN-slug.md)` with `(../slug/)`
106+
3. Verify the build: `npm run build`
107+
108+
The filename in `content/docs/` drops the number prefix (e.g.
109+
`01-introduction.md``introduction.md`).
110+
111+
### 3.3 Building for production
100112

101113
```bash
102114
cd astro-site
103115
npm run build # output in dist/
104116
npm run preview # preview the production build
105117
```
106118

107-
### 3.3 Deployment
119+
### 3.4 Deployment
108120

109121
Push to `main` — GitHub Actions builds and deploys to GitHub Pages
110-
automatically.
122+
automatically. The CI creates the assets symlink before building.
111123

112124

113125
## 4. Git workflow

docs/dev-journal.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Architecture overview and chronological session log for tutorial-git.
77

88
- **Content**: Markdown files in `chapters/` (SSG-agnostic)
99
- **Assets**: `assets/images/` (PNGs), `assets/drawio/` (source diagrams)
10-
- **Site**: Astro static site in `astro-site/` (not yet wired to chapters)
10+
- **Site**: Astro static site in `astro-site/` (wired to chapters via content collection)
1111
- **Templates**: `docs/solid-ai-templates/` submodule for CLAUDE.md generation
1212
- **Hosting**: GitHub Pages via GitHub Actions
1313

@@ -83,3 +83,35 @@ Architecture overview and chronological session log for tutorial-git.
8383

8484
**Open issues:**
8585
- #72 — Deploy as GitHub Page (Astro site scaffolded, not wired to chapters)
86+
87+
### 2026-04-20 — Astro site wiring and content polish
88+
89+
**Tool:** Claude Code (Opus 4.6)
90+
91+
**Key changes:**
92+
- Wired all 9 chapters to Astro site as single-page sections
93+
- Removed operations subsections (10 files) and test pages (2 files)
94+
- Renamed concepts to building-blocks to match canonical chapter
95+
- Added assets symlink in `src/content/` for image resolution
96+
- Switched CI pipeline from MkDocs to Astro (Node.js 22)
97+
- Added `base: '/tutorial-git/'` for GitHub Pages deployment
98+
- Disabled Shiki syntax highlighting — dark terminal code blocks
99+
- Added hamburger menu for mobile nav (≤768px breakpoint)
100+
- Numbered h2 headings across all chapters, added learning objectives
101+
- Collapsible ToC — h2 visible, h3+ expandable on click
102+
- Improved nav visibility — darker tab bar, WCAG AA contrast
103+
- Teal underline on h2, muted h3 color for visual hierarchy
104+
- Consolidated installation instructions (download → table → verify)
105+
- Rewrote introduction exercises as linear flow (install → clone → add → commit → push → pull)
106+
- Updated quiz to test core concepts (index, commit chain)
107+
- Replaced object model diagram — vertical commit chain layout
108+
- Created object types draw.io diagram with concrete example data
109+
- Fixed broken cross-references in all chapters (file links → site URLs)
110+
- Removed 9 dead tutorial sidebar links (only Azure and Python live)
111+
- Updated home page, README (solid-ai-templates conformant)
112+
- Upstreamed README spec change to solid-ai-templates (merged Overview into Title)
113+
- Closed issues: #72, #83, #84, #88, #89, #90, #91, #92, #93, #94, #98
114+
115+
**Open issues:**
116+
- #100 — Add search functionality
117+
- #101 — Evaluate hamburger vs horizontal scroll for mobile nav

0 commit comments

Comments
 (0)