docs(book): split book into versioned v1.5.0 / v2.0.0 editions#174
Merged
Conversation
Split is directory-based on main (not branch-based). The existing flat
docs/book/ tree is renamed to docs/book/v1.5.0/ (frozen 1.x edition);
docs/book/v2.0.0/ is a full copy (assets duplicated) that will receive
Phrase Algebra content. Each edition carries its own book.yaml with a
version-stamped subtitle ("… (v1.5)" and "… (v2.0 — Phrase Algebra)").
build-book.sh is now version-aware: `build-book.sh <version> [format]`
resolves docs/book/<version>/ and outputs the-sharpee-book-<version>.<ext>.
Usage/error paths verified; a live v1.5.0 html render confirmed correct.
Follow-up needed: extract-book-snippets.cjs, book-web-nav.cjs,
build-snippet-page.cjs, and site/book-snippets.html still reference
the old flat docs/book path and need version-awareness.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Splits The Sharpee Author and Developer Manual into two versioned editions on
main(directory-based, not branch-based), so the 1.x and phrase-algebra lines each have their own docs. Docs + build-script only — no platform or story code.Part of the v1.5 / v2.0 release plan (v1.x republished uniformly as 1.5.0; this workspace publishes as 2.0.0).
Changes
docs/book/v1.5.0/— the current book moved here intact (git-tracked as renames); the frozen 1.x edition. Subtitle "… (v1.5)".docs/book/v2.0.0/— full copy with assets duplicated (each edition self-contained); will receive the Phrase Algebra + updated-tutorial content. Subtitle "… (v2.0 — Phrase Algebra)". (Part V ch19 "The Formatter Chain" is the 1.x system Phrase Algebra replaces, so that chapter will diverge.)scripts/build-book.sh— now version-aware:build-book.sh <version> [html|epub|pdf|web|snippets|all], resolvesdocs/book/<version>, outputsthe-sharpee-book-<version>.<ext>into each edition's ownbuild/. Verified: usage/error paths + a livev1.5.0 htmlrender.Follow-up (not in this PR)
The snippet/web/site helper scripts still reference the old flat
docs/book/path and need version-awareness:scripts/extract-book-snippets.cjs,scripts/book-web-nav.cjs,scripts/build-snippet-page.cjs,site/book-snippets.html. Core html/epub/pdf builds work per-version.🤖 Generated with Claude Code