Skip to content

Restructure the book to the 3rd-edition layout (OUTLINE.md + content moves) - #19

Merged
schacon merged 5 commits into
mainfrom
cursor/restructure-outline-6d3c
Aug 3, 2026
Merged

Restructure the book to the 3rd-edition layout (OUTLINE.md + content moves)#19
schacon merged 5 commits into
mainfrom
cursor/restructure-outline-6d3c

Conversation

@schacon

@schacon schacon commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

Three things on this branch:

  1. OUTLINE.md — the canonical punch list for the 3rd edition: one table row per section (Section, Title, Description, Effort, Status), per-chapter source-file notes, the dropped-content survivor map, open decisions, and cross-cutting mechanical tasks.
  2. The restructure itselfbook/ now matches that layout. No book prose was written or rewritten; this is moves, renames, placeholders, and cross-reference plumbing.
  3. Cross-reference rendering fix — links no longer render as raw filenames.

New chapter map

Getting Started · Git Basics · Git Branching · Distributed Git (ch04, was ch05) · Git Toolkit (ch05, was ch07 "Git Tools") · Customizing Git (ch06, was ch08) · Git and Agents (ch07, new) · Git Servers (ch08, was ch04 "Git on the Server") · Git at Scale (ch09, new) · Git Internals (ch10) · Appendix A: Git Commands (was Appendix C)

Dropped: the GitHub chapter (ch06/), Git and Other Systems (ch09/), Appendix A (environments), Appendix B (embedding), plus 68 images referenced only by those chapters.

What was added

  • Placeholder chapters in the preface's outline-notes style: ch07-git-and-agents.asc (5 sections) and ch09-git-at-scale.asc (7 sections), each with AUTHOR TODO markers so humans write the prose.
  • Placeholder sections: ch03/worktrees.asc (3.5), ch04/pull-requests.asc (4.3), ch06/ignoring.asc (6.2).
  • The 4.3 placeholder carries the rescued anchors from the dropped GitHub chapter (_pr_refs, _fetch_and_push_on_different_repositories, _email_notifications), so every existing cross-reference still resolves.

Cross-reference handling

  • All xrefs retargeted to the new chapter names; appendix entries pointing at the dropped Other Systems chapter commented out with AUTHOR TODO notes; prose made inaccurate by the reordering flagged with AUTHOR TODO comments for human rewriting.
  • Link rendering fix: all 218 inter-document xrefs (<<chXX-file#anchor>>) converted to internal xrefs with explicit link text (<<anchor,Ch N, Title>>). Asciidoctor rendered the old form as a dead inter-document link whose visible text was the raw filename ("ch01-getting-started.html"); the book builds as a single document, so the internal form is correct in every output format, and the reader's link rewriter now maps them to the right section pages automatically. Anchors verified unique book-wide.

Verification

  • HTML/EPUB/FB2/PDF all build with no warnings; all 213 internal links in the generated HTML resolve (scripted check; the only remaining .html hrefs are four external URLs).
  • Reader demo of the new structure:

Reader TOC showing Git and Agents, Git Servers, Git at Scale chapters

restructured_book_reader_toc_and_placeholders.mp4

  • Cross-references now render as chapter labels and navigate correctly:

Appendix git config entry with links rendered as Ch N, Title labels

fixed_chapter_links_appendix_demo.mp4

Open in Web Open in Cursor 

cursoragent and others added 2 commits August 3, 2026 15:25
Co-authored-by: Scott Chacon <schacon@gmail.com>
Co-authored-by: Scott Chacon <schacon@gmail.com>
@cursor cursor Bot changed the title Add RESTRUCTURE_PLAN.md: full chapter/section outline for the 3rd-edition restructure Add restructure plan and OUTLINE.md punch list for the 3rd edition Aug 3, 2026
Co-authored-by: Scott Chacon <schacon@gmail.com>
@cursor cursor Bot changed the title Add restructure plan and OUTLINE.md punch list for the 3rd edition Add OUTLINE.md: chapter/section punch list for the 3rd-edition restructure Aug 3, 2026
- Renumber chapters: Distributed Git to ch04, Git Toolkit (was Git Tools)
  to ch05, Customizing Git to ch06, Git Servers (was Git on the Server)
  to ch08; Git Internals stays ch10
- Drop the GitHub chapter, Git and Other Systems, and appendices A
  (environments) and B (embedding); the command reference becomes
  Appendix A (A-git-commands.asc)
- Add new placeholder chapters: ch07 Git and Agents and ch09 Git at
  Scale, with outline-note placeholder sections in the preface style
- Add placeholder sections: 3.5 Worktrees, 4.3 Pull Requests and Forges
  (carrying the rescued _pr_refs, _fetch_and_push_on_different_repositories
  and _email_notifications anchors), 6.2 Ignoring Files
- Retarget all cross-references to the new chapter file names; comment
  out appendix entries pointing at the dropped Other Systems chapter
  with AUTHOR TODO notes; flag now-wrong chapter-order prose with
  AUTHOR TODO comments
- Remove 68 images referenced only by dropped chapters
- HTML/EPUB/FB2/PDF all build; all 138 internal links resolve

Co-authored-by: Scott Chacon <schacon@gmail.com>
@cursor cursor Bot changed the title Add OUTLINE.md: chapter/section punch list for the 3rd-edition restructure Restructure the book to the 3rd-edition layout (OUTLINE.md + content moves) Aug 3, 2026
Convert all 218 inter-document xrefs (<<chXX-file#anchor>>) to internal
xrefs with explicit link text (<<anchor,Ch N, Title>>). Asciidoctor
rendered the old form as a dead interdocument link whose text was the
raw filename (e.g. "ch01-getting-started.html"); the monolithic book
is a single document, so internal refs are correct in every format and
the reader's page-splitting link rewriter now maps them to the right
section pages automatically.

All anchors are unique book-wide (verified), internal hrefs in the
generated HTML went from 138 to 213 with zero unresolved targets, and
HTML/EPUB/FB2/PDF all build cleanly.

Co-authored-by: Scott Chacon <schacon@gmail.com>
@schacon
schacon marked this pull request as ready for review August 3, 2026 19:22
@cursor

cursor Bot commented Aug 3, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@schacon
schacon merged commit 4c124da into main Aug 3, 2026
1 check passed
@schacon
schacon deleted the cursor/restructure-outline-6d3c branch August 3, 2026 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants