How thesobersobber/bluebook works
Key Components to Include:
User Input Layer
• Google Form for submissions
• Gmail for email processing
• Academic email filtering system
Automation Layer
• Google Apps Script Components:
• Form-to-PR processor
• Gmail-to-Proxy email handler
• GitHub Actions workflows:
• Deployment workflow
• Content generation
• Moderation system
Content Management Layer
• Hugo Static Site Generator
• Content structure:
• Responses section
• Archives
• Authorization guide
Storage & Hosting Layer
• GitHub repository
• Static site hosting
A top-down flow approach
• Rectangles: Main systems (Hugo, GitHub, Google Services)
• Circles: Integration points
• Diamonds: Decision points in automation
Create four main sections
• [User Input] → [Automation] → [Processing] → [Output]
Detail the connections
• [Google Form] ─→ [Apps Script] ─→ [GitHub PR] ─→ [Hugo Build]
• [Gmail] ─→ [Email Filter] ─→ [Apps Script] ─→ [Form Submission]
Automation workflows
• [GitHub Actions] ─┬→ [Deploy]
• → [Generate]
• → [Moderate]
Key Relationships to Highlight:
Form Submission Flow
• User submission → Google Form → Apps Script → GitHub PR
• Email → Gmail Filter → Apps Script → Form submission
Content Processing Flow
• PR creation → GitHub Actions → Hugo generation → Site deployment
Moderation System
• PR review → Moderation workflow → Content approval
Important Technical Details:
Integration Points
• GitHub PAT for authentication
• Form ID and email regex for filtering
• Webhook triggers between systems
Automation Triggers
• Form submission triggers
• Time-based email processing
• GitHub workflow triggers
Use these specific symbols:
• 🔄 for automated processes
• 🔑 for authentication points
• 📝 for content creation
• 🚀 for deployment
• 🔍 for filtering/moderation
Level of Detail:
• Keep high-level flow visible
• Use expandable sections for complex processes
• Timing and trigger information
• Document authentication boundaries
Remember to:
Backup/fallback processes
This system design should emphasize the automated nature of the content pipeline while maintaining clarity about the separation of concerns between different services and systems.