{{BOOK_TITLE}}
This repository contains the manuscript workspace for "{{BOOK_TITLE}}".
Quick Start
- Define the primary and secondary readers in
docs/reader-personas.md - Review
docs/page-allocation.mdand set character targets - Review
docs/schedule.mdand replace placeholder dates - Keep
docs/release-readiness-record.mdunused until a release candidate is frozen - Edit
.github/copilot-instructions.mdfor project goals and constraints - Start outlining in
keypoints/ - Write drafts in
sections/
Repository Structure
| Path | Purpose |
|---|---|
keypoints/ |
Outline and key-point drafts |
sections/ |
Main manuscript files |
re-view-output/ |
Optional Re:VIEW source and PDF output |
images/ |
Figures and screenshots |
materials/ |
Reference sources |
.github/agents/ |
Writing workflow agents |
.github/instructions/ |
Writing conventions |
docs/ |
Reader personas, schedule, naming rules, and writing docs |
scripts/ |
Counting and conversion helpers |
Common Commands
python scripts/count_chars.py
# If Re:VIEW/PDF support is enabled:
# python scripts/convert_md_to_review.py
# python scripts/build_review_pdf.py
# python scripts/inspect_pdf.py pdf/book.pdfWorkflow
- Draft the structure in
keypoints/ - Write the manuscript in
sections/ - Review with
@writing-reviewer - Convert with
scripts/convert_md_to_review.pyif Re:VIEW support is enabled - Build or polish PDF assets only when PDF output is in scope
- Freeze the release candidate and complete
docs/release-readiness-record.mdbefore delivery
Metadata Layer
- Put stable shared cover and colophon defaults in
config/review-metadata/common.yml - Put project-specific author, publisher, title, subtitle, and series badge values in
config/review-metadata/project.yml - If the repo contains a series, compare title naming patterns across books before fixing one title alone
- Regenerate Re:VIEW config and cover assets through the helper scripts instead of editing generated files directly