Setup Workflow
Use the setup script to create a new manuscript workspace from the bundled templates.
Command
python scripts/setup_workspace.py `
--name "project-name" `
--title "Book Title" `
--path "D:\target\path" `
--chapters 8
# Add Re:VIEW/PDF support only when the project needs it.
python scripts/setup_workspace.py `
--name "project-name" `
--title "Book Title" `
--path "D:\target\path" `
--chapters 8 `
--with-reviewMain Options
| Option | Meaning |
|---|---|
--name |
Folder name for the new workspace |
--title |
Human-readable book title |
--path |
Parent directory where the workspace will be created |
--chapters |
Number of generated chapter folders |
--chapter-titles |
Explicit chapter names instead of defaults |
--with-review |
Add optional Re:VIEW/PDF scaffolding |
--with-materials |
Add materials/references/ |
--no-materials |
Skip materials/ |
What Gets Generated
- Folder structure for outlines, drafts, images, docs, and optional output
- Writing/review agents and writing instructions under
.github/ - Project docs such as
README.md,docs/reader-personas.md,docs/page-allocation.md, anddocs/schedule.md - Helper scripts such as
scripts/count_chars.py - Initial chapter intro files in both outline and manuscript folders
- Optional Re:VIEW/PDF scripts and metadata when
--with-reviewis used
Post-Setup Checks
- Open the generated
README.mdand confirm project metadata - Replace all placeholders in
docs/reader-personas.md - Edit
docs/page-allocation.mdto fit the book length - Edit
docs/schedule.mdto replace placeholder dates - Adjust
.github/copilot-instructions.mdfor project goals and constraints