How zachgoldberg/startup-cto-handbook works
Project type and purpose
• This is not a web-app or microservice ecosystem but a single‐purpose content repository: the source for “The Startup CTO’s Handbook” book.
• Its primary function is to hold Markdown-based manuscript files, track contributions, generate published artifacts (PDF, DOCX), and link to distribution channels (Amazon, Audible).
File structure
• Top‐level files:
• ACKNOWLEDGMENTS, LICENSE, README.md, StartupCTOHandbook.md (the live manuscript)
• published_files/ – contains the generated PDF and DOCX that are the deliverables
• There are no code directories, no build scripts checked in, so the build pipeline is external or manual (likely Pandoc or a similar tool).
README for additional insights
• The README confirms:
• The Markdown source is the single source of truth.
• Outputs are published files in PDF and DOCX form.
• Contributions are via GitHub pull requests; the author invites edits and tracks acknowledgments.
• No CI configuration is present; assume a manual or external CI/CD process that reads the Markdown and outputs the published_files.
a. Main components
• Author/Contributor Workstation
• Version Control System (GitHub repo)
• Build/Conversion Step (Pandoc or custom script)
• Published Artifacts (PDF, DOCX in published_files/)
• External Distribution Channels (Amazon, Audible, Google Docs for legacy)
b. Relationships & interactions
1. Author writes/edits StartupCTOHandbook.md (and possibly ACKNOWLEDGMENTS).
2. Changes are committed and pushed to GitHub.
3. A build step (manual or CI) triggers conversion of Markdown → PDF/DOCX.
4. Outputs are stored in published_files/.
5. Final artifacts are uploaded or synced to Amazon, Audible, or other publishing endpoints.
6. (Optional) Legacy Google Doc updates are reconciled back into Markdown.
c. Architectural patterns & principles
• Single‐source‐of‐truth content (Markdown)
• Linear content‐to‐artifact pipeline
• Clear separation: source control vs. build process vs. distribution
• Contributor workflow via pull requests
d. Key technologies/frameworks
• Markdown (content)
• Git/GitHub (version control)
• Pandoc or equivalent (conversion engine)
• PDF/DOCX formats (artifacts)
• External services: Amazon KDP, Audible ACX, Google Docs