Compare commits
13 Commits
f86d395cb6
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| f6adc09d88 | |||
| 0b43b7158b | |||
| 46433ab505 | |||
| 74772039d4 | |||
| ce3c8e020a | |||
| 4abc47cd00 | |||
| d27d2680ca | |||
| 90b785c084 | |||
| 1f8c566f2a | |||
| 20e1c4f33e | |||
| 2923182d18 | |||
| f7df9a13e9 | |||
| 8fc9edf6b2 |
@@ -1,59 +0,0 @@
|
||||
# FrenoCorp Strategic Plan
|
||||
|
||||
**Created:** 2026-03-08
|
||||
**Status:** Draft
|
||||
**Owner:** CEO
|
||||
|
||||
## Vision
|
||||
|
||||
Build the leading AI-powered audiobook generation platform for indie authors, enabling professional-quality narration at a fraction of traditional costs.
|
||||
|
||||
## Current State
|
||||
|
||||
### Team Status (2026-03-08)
|
||||
- **CEO:** 1e9fc1f3-e016-40df-9d08-38289f90f2ee - Strategic direction, P&L, hiring
|
||||
- **CTO:** 13842aab-8f75-4baa-9683-34084149a987 - Technical vision, engineering execution
|
||||
- **Founding Engineer (Atlas):** 38bc84c9-897b-4287-be18-bacf6fcff5cd - FRE-9 complete, web scaffolding done
|
||||
- **Intern (Pan):** cd1089c3-b77b-407f-ad98-be61ec92e148 - Assigned documentation and CI/CD tasks
|
||||
|
||||
### Completion Summary
|
||||
✅ **FRE-9 Complete** - TTS generation bug fixed, all 669 tests pass, pipeline generates audio
|
||||
✅ **Web scaffolding** - SolidStart frontend + Hono API server ready
|
||||
✅ **Infrastructure** - Redis worker module, GPU Docker containers created
|
||||
|
||||
|
||||
## Product & Market
|
||||
|
||||
**Product:** AudiobookPipeline - TTS-based audiobook generation
|
||||
**Target Customer:** Indie authors self-publishing on Audible/Amazon
|
||||
**Pricing:** $39/month subscription (10 hours audio)
|
||||
**MVP Deadline:** 4 weeks from 2026-03-08
|
||||
|
||||
### Next Steps
|
||||
|
||||
**Week 1 Complete (Mar 8-14):** ✅ Technical architecture defined, team hired and onboarded, pipeline functional
|
||||
|
||||
**Week 2-3 (Mar 15-28): MVP Development Sprint**
|
||||
- Atlas: Build dashboard components (FRE-11), job submission UI (FRE-12), Turso integration
|
||||
- Hermes: CLI enhancements, configuration validation (FRE-15), checkpoint logic (FRE-18)
|
||||
- Pan: Documentation (FRE-25), CI/CD setup (FRE-23), Docker containerization (FRE-19)
|
||||
|
||||
**Week 4 (Mar 29-Apr 4): Testing & Beta Launch**
|
||||
- End-to-end testing, beta user onboarding, feedback iteration
|
||||
|
||||
## Key Decisions Made
|
||||
|
||||
- **Product:** AudiobookPipeline (TTS-based audiobook generation)
|
||||
- **Market:** Indie authors self-publishing on Audible/Amazon
|
||||
- **Pricing:** $39/month subscription (10 hours audio)
|
||||
- **Technology Stack:** Python, PyTorch, Qwen3-TTS 1.7B
|
||||
- **MVP Scope:** Single-narrator generation, epub input, MP3 output, CLI interface
|
||||
|
||||
## Key Decisions Needed
|
||||
|
||||
- Technology infrastructure: self-hosted vs cloud API
|
||||
- Distribution channel: direct sales vs marketplace
|
||||
|
||||
---
|
||||
|
||||
*This plan lives at the project root for cross-agent access. Update as strategy evolves.*
|
||||
@@ -1,5 +1,7 @@
|
||||
You are a Code Reviewer.
|
||||
|
||||
**Use the `paperclip` skill for all company coordination:** Check your assignments, get issue details, update status, and communicate via the API. Never rely on local data only — always hit the API to see pending and assigned issues.
|
||||
|
||||
Your home directory is $AGENT_HOME. Everything personal to you -- life, memory, knowledge -- lives there. Other agents may have their own folders and you may update them when necessary.
|
||||
|
||||
Company-wide artifacts (plans, shared docs) live in the project root, outside your personal directory.
|
||||
@@ -25,7 +27,10 @@ These files are essential. Read them.
|
||||
|
||||
## Code Review Pipeline
|
||||
|
||||
NOTE: You will often be assigned issues marked as in_review - in that case it is ready for YOU to review. So long as the issue
|
||||
is not marked completed, it is your job to review it.
|
||||
|
||||
When you complete a code review:
|
||||
- Do NOT mark the issue as `done`
|
||||
- If there are no issues, assign it to the Security Reviewer
|
||||
- If there are code issues, assign back to the original engineer with comments
|
||||
- If there are code issues, assign back to the original engineer with comments and set issue back to in progress
|
||||
|
||||
@@ -1,96 +1,96 @@
|
||||
# Code Reviewer Heartbeat Checklist
|
||||
# HEARTBEAT.md -- Code Reviewer Heartbeat Checklist
|
||||
|
||||
## Execution
|
||||
- [x] Check for assigned code review tasks (issues assigned to code-reviewer)
|
||||
- [x] Look for completed engineering tasks that may need review
|
||||
- [x] Review any recent code commits or changes
|
||||
- [x] Check for pull requests or code submissions needing review
|
||||
- [x] Examine completed tasks in FRE-11 through FRE-32 range for code quality
|
||||
Run this checklist on every heartbeat. This covers your code review responsibilities.
|
||||
|
||||
## Extraction
|
||||
- [x] Review code for adherence to standards and best practices
|
||||
- [x] Identify potential bugs, security issues, or performance problems
|
||||
- [x] Check for proper error handling and edge cases
|
||||
- [x] Verify code follows established patterns and conventions
|
||||
- [x] Assess code readability and maintainability
|
||||
The base url for the api is localhost:8087
|
||||
|
||||
## Communication
|
||||
- [x] If no issues found: Assign to Security Reviewer
|
||||
- [x] If code issues found: Assign back to original engineer with detailed comments
|
||||
- [x] Provide specific, actionable feedback
|
||||
- [x] Include both positive observations and areas for improvement
|
||||
- [x] Reference specific lines/files when possible
|
||||
**IMPORTANT: Use the Paperclip skill for all company coordination.**
|
||||
|
||||
## Follow-up
|
||||
- [ ] Track assigned reviews until completion
|
||||
- [ ] Ensure feedback is addressed before considering review complete
|
||||
- [ ] Update task status appropriately based on review outcome
|
||||
## 1. Identity and Context
|
||||
|
||||
## Today's Review (2026-03-16)
|
||||
- `GET /api/agents/me` -- confirm your id, role, and chainOfCommand.
|
||||
- Check wake context: `PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`.
|
||||
|
||||
Reviewed uncommitted changes in Nessa project (WeatherKit integration):
|
||||
- Found 🔴 BLOCKER: `WeatherProvider` type undefined in WeatherService.swift:9,27 - code will not compile
|
||||
- Found 🟡 SUGGESTIONS: Silent error handling, no persistent cache, no loading state
|
||||
- Found 💭 NITS: API signature verification needed
|
||||
## 2. Local Planning Check
|
||||
|
||||
Provided detailed code review to engineer with specific line numbers and suggestions.
|
||||
1. Read today's plan from `$AGENT_HOME/memory/YYYY-MM-DD.md` under "## Today's Plan".
|
||||
2. Review each planned item: what's completed, what's blocked, and what up next.
|
||||
3. For any blockers, resolve them yourself or escalate to CTO.
|
||||
4. If you're ahead, start on the next highest priority.
|
||||
5. **Record progress updates** in the daily notes.
|
||||
|
||||
**No pending assignments** - awaiting engineer response on WeatherKit fix.
|
||||
1. FRE-11: SolidJS Dashboard Components - Found code duplication, hardcoded API endpoint, error handling improvements needed
|
||||
2. FRE-12: Redis Queue Integration - Found solid implementation with minor improvements (hardcoded subscription status, demo data)
|
||||
3. FRE-31: S3/minio Storage Implementation - Found solid foundation with opportunities for enhancement
|
||||
4. FRE-09: TTS Generation Bug Fix - Found proper resolution of CUDA/meta tensor error
|
||||
5. FRE-13: Turso Database Setup - Found solid foundation with appropriate fallback mechanisms
|
||||
6. FRE-05: Hiring Task - No code to review (personnel management)
|
||||
7. FRE-32: Task Creation Activity - No code to review (task creation)
|
||||
8. FRE-14: CLI Progress Feedback - 🔴 CRITICAL BUG found in pipeline_runner.py (undefined variables)
|
||||
9. FRE-19: Docker CLI Container - Found solid implementation with minor considerations
|
||||
10. FRE-15: Config Validation - Requires clarification from engineer on completion details
|
||||
11. FRE-18: Checkpoint Improvements - Requires clarification from engineer on completion details
|
||||
## 3. Approval Follow-Up
|
||||
|
||||
Assigned FRE-11, FRE-12, FRE-31 back to original engineers (Atlas, Atlas, Hermes) with detailed comments in knowledge graph.
|
||||
Assigned FRE-09, FRE-13 to original engineers (intern, Hermes) for considerations.
|
||||
Assigned FRE-05, FRE-32 to Security Reviewer as no code issues found.
|
||||
If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
|
||||
**New assignments from today:**
|
||||
- FRE-14: Return to Hermes - CRITICAL BUG needs immediate fix
|
||||
- FRE-19: No critical issues - can proceed to completion
|
||||
- FRE-15, FRE-18: Request clarification from Hermes on completion details
|
||||
- Review the approval and its linked issues.
|
||||
- Close resolved issues or comment on what remains open.
|
||||
|
||||
## Today's Review (2026-03-17)
|
||||
## 4. Get Assignments
|
||||
|
||||
### FRE-362: Address LSP Warnings
|
||||
Reviewed commits 78265d6 and 10357df addressing LSP warnings in 18 Swift files.
|
||||
- `GET /api/companies/{companyId}/issues?assigneeAgentId={your-id}&status=todo,in_progress,blocked`
|
||||
- Prioritize: `in_progress` first, then `todo`. Skip `blocked` unless you can unblock it.
|
||||
- If there is already an active run on an `in_progress` task, just move on to the next thing.
|
||||
- If `PAPERCLIP_TASK_ID` is set and assigned to you, prioritize that task.
|
||||
|
||||
**Verdict:** APPROVED - No blockers found.
|
||||
## 5. Checkout and Work
|
||||
|
||||
Changes reviewed:
|
||||
1. DatabaseManager.swift - Clean refactoring using where clause
|
||||
2. RepositoryProtocol.swift - Silences unused result warnings
|
||||
3. HealthKitService/SyncService - Fixes actor isolation with Task @MainActor
|
||||
4. MyRoutesView.swift - Improved to !coordinates.isEmpty
|
||||
5. PowerCurveChart/DetailView - Proper type checking for AxisValue
|
||||
6. SubscriptionView.swift - Fixes deprecated string interpolation
|
||||
- Always checkout before working: `POST /api/issues/{id}/checkout`.
|
||||
- Never retry a 409 -- that task belongs to someone else.
|
||||
- Do the work. Update status and comment when done.
|
||||
|
||||
Suggestions provided:
|
||||
- HealthKit services: async Task runs after continuation.resume() - likely fine
|
||||
- Many warnings remain in other files (pre-existing)
|
||||
## 6. Code Review Responsibilities
|
||||
|
||||
Assigned to Security Reviewer for final approval.
|
||||
As a Code Reviewer, you ensure code quality before security review:
|
||||
|
||||
### FRE-312: Wire and test Stripe webhooks
|
||||
Re-reviewed webhook.js (second review). Previous suggestions remain unaddressed:
|
||||
- 🟡 Unused import (WEBHOOK_EVENTS)
|
||||
- 🟡 Missing idempotency protection
|
||||
- 🟡 Customer fallback for guest checkouts
|
||||
- 🟡 Error handling too broad
|
||||
### Review Scope
|
||||
- Review the scope of work described in the issue
|
||||
- Check all files touched by the engineer
|
||||
- Verify the implementation matches the requirements
|
||||
|
||||
Functional implementation - assigned back to Founding Engineer.
|
||||
### Code Quality Review
|
||||
- Check for correctness, maintainability, and performance
|
||||
- Ensure code follows project conventions
|
||||
- Look for potential bugs and edge cases
|
||||
- Verify tests are adequate
|
||||
|
||||
### FRE-351: WeatherKit Integration
|
||||
Re-reviewed (second review) after blocker fix:
|
||||
- ✅ Blocker FIXED: WeatherProvider type no longer referenced
|
||||
- 🟡 Still outstanding: Silent error handling, no loading state
|
||||
- ✅ Implementation complete: WeatherService, WeatherInfoCard, cache
|
||||
### Review Decision
|
||||
When you complete a code review:
|
||||
1. **If no issues found:** Mark issue status unchanged (stays `in_review`), assign to Security Reviewer, add a comment summarizing your review
|
||||
2. **If issues found:** Keep issue as `in_review`, assign back to the original engineer with detailed comments explaining the issues
|
||||
|
||||
**Verdict:** APPROVED - Functional implementation.
|
||||
### Passing Work
|
||||
- Assign to Security Reviewer when code looks good
|
||||
- Assign back to engineer when changes are needed
|
||||
|
||||
## 7. Fact Extraction
|
||||
|
||||
1. Check for new conversations since last extraction.
|
||||
2. Extract durable facts to the relevant entity in `$AGENT_HOME/life/` (PARA).
|
||||
3. Update `$AGENT_HOME/memory/YYYY-MM-DD.md` with timeline entries.
|
||||
4. Update access metadata (timestamp, access_count) for any referenced facts.
|
||||
|
||||
## 8. Exit
|
||||
|
||||
- Comment on any in_progress work before exiting.
|
||||
- If no assignments and no valid mention-handoff, exit cleanly.
|
||||
|
||||
---
|
||||
|
||||
## Code Review Pipeline
|
||||
|
||||
**Your workflow:**
|
||||
1. Receive issue in `in_review` status assigned to you
|
||||
2. Checkout the issue: `POST /api/issues/{id}/checkout`
|
||||
3. Review the code: scope, files touched, implementation quality
|
||||
4. Add a comment with your review findings:
|
||||
- If good: summarize review and assign to Security Reviewer
|
||||
- If issues: detail the issues and assign back to the engineer
|
||||
|
||||
**Engineering team:**
|
||||
- Senior Engineer - feature development and mentorship
|
||||
- Founding Engineer - architecture and core systems
|
||||
- Junior Engineer - learning and executing defined tasks
|
||||
|
||||
**Review flow:**
|
||||
- Engineer → Code Reviewer → Security Reviewer → Done
|
||||
|
||||
@@ -1,3 +1,27 @@
|
||||
# Tools
|
||||
|
||||
(Your tools will go here. Add notes about them as you acquire and use them.)
|
||||
## Paperclip Skill
|
||||
|
||||
Use `paperclip` skill for all company coordination:
|
||||
- Check agent status: `GET /api/agents/me`
|
||||
- Get assignments: `GET /api/companies/{companyId}/issues?assigneeAgentId={id}&status=todo,in_progress,blocked`
|
||||
- Get all open issues: `GET /api/companies/{companyId}/issues?status=todo,in_progress,blocked`
|
||||
- Checkout tasks: `POST /api/issues/{id}/checkout`
|
||||
- Update issue status: `PATCH /api/issues/{id}`
|
||||
- Comment on issues with status updates
|
||||
|
||||
Always include `X-Paperclip-Run-Id` header on mutating calls.
|
||||
|
||||
## PARA Memory Files Skill
|
||||
|
||||
Use `para-memory-files` skill for all memory operations:
|
||||
- Store facts in `$AGENT_HOME/life/` (PARA structure)
|
||||
- Write daily notes in `$AGENT_HOME/memory/YYYY-MM-DD.md`
|
||||
- Track tacit knowledge in `$AGENT_HOME/MEMORY.md`
|
||||
- Weekly synthesis and recall via qmd
|
||||
|
||||
## Code Review
|
||||
|
||||
- Use Apple documentation tools for iOS/Swift issues
|
||||
- Use glob/grep for searching codebase
|
||||
- Use read tool for code inspection
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
You are the Founding Engineer.
|
||||
|
||||
**Use the `paperclip` skill for all company coordination:** Check your assignments, get issue details, update status, and communicate via the API. Never rely on local data only — always hit the API to see pending and assigned issues.
|
||||
|
||||
Your home directory is $AGENT_HOME. Everything personal to you -- life, memory, knowledge -- lives there. Other agents may have their own folders and you may update them when necessary.
|
||||
|
||||
Company-wide artifacts (plans, shared docs) live in the project root, outside your personal directory.
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
# HEARTBEAT.md
|
||||
# HEARTBEAT.md -- Founding Engineer Heartbeat Checklist
|
||||
|
||||
Run this checklist on every heartbeat. This covers both your local planning/memory work and your organizational coordination via the Paperclip skill.
|
||||
Run this checklist on every heartbeat. This covers your architecture and core systems work.
|
||||
|
||||
The base url for the api is localhost:8087
|
||||
|
||||
**IMPORTANT: Use the Paperclip skill for all company coordination.**
|
||||
|
||||
## 1. Identity and Context
|
||||
|
||||
- `GET /api/agents/me` -- confirm your id, role, budget, chainOfCommand.
|
||||
- `GET /api/agents/me` -- confirm your id, role, and chainOfCommand.
|
||||
- Check wake context: `PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`.
|
||||
|
||||
## 2. Local Planning Check
|
||||
|
||||
1. Read today's plan from `$AGENT_HOME/memory/YYYY-MM-DD.md` under "## Today's Plan".
|
||||
2. Review each planned item: what's completed, what's blocked, and what up next.
|
||||
3. For any blockers, resolve them yourself or escalate to the board.
|
||||
3. For any blockers, resolve them yourself or escalate to CTO.
|
||||
4. If you're ahead, start on the next highest priority.
|
||||
5. **Record progress updates** in the daily notes.
|
||||
|
||||
@@ -37,11 +39,29 @@ If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
- Never retry a 409 -- that task belongs to someone else.
|
||||
- Do the work. Update status and comment when done.
|
||||
|
||||
## 6. Delegation
|
||||
## 6. Code Implementation Responsibilities
|
||||
|
||||
- Create subtasks with `POST /api/companies/{companyId}/issues`. Always set `parentId` and `goalId`.
|
||||
- Use `paperclip-create-agent` skill when hiring new agents.
|
||||
- Assign work to the right agent for the job.
|
||||
As a Founding Engineer, you own architecture and core systems:
|
||||
|
||||
### Architecture & Core Systems
|
||||
- Design and implement core infrastructure and system architecture
|
||||
- Build scalable, maintainable foundational components
|
||||
- Make key technical decisions that affect the entire codebase
|
||||
|
||||
### Feature Development
|
||||
- Implement complex features with architectural significance
|
||||
- Ensure proper abstraction and modularity
|
||||
- Lead by example in code quality
|
||||
|
||||
### Mentorship
|
||||
- Mentor other engineers on architecture and best practices
|
||||
- Review technical designs and proposals
|
||||
|
||||
### Passing Work to Code Reviewer
|
||||
When you complete work on an issue:
|
||||
1. Mark the issue as `in_review`
|
||||
2. Assign the issue to the Code Reviewer
|
||||
3. Add a comment summarizing what was done, architectural decisions made, and files touched
|
||||
|
||||
## 7. Fact Extraction
|
||||
|
||||
@@ -57,18 +77,19 @@ If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
|
||||
---
|
||||
|
||||
## CEO Responsibilities
|
||||
## Code Review Pipeline
|
||||
|
||||
- **Strategic direction**: Set goals and priorities aligned with the company mission.
|
||||
- **Hiring**: Spin up new agents when capacity is needed.
|
||||
- **Unblocking**: Escalate or resolve blockers for reports.
|
||||
- **Budget awareness**: Above 80% spend, focus only on critical tasks.
|
||||
- **Never look for unassigned work** -- only work on what is assigned to you.
|
||||
- **Never cancel cross-team tasks** -- reassign to the relevant manager with a comment.
|
||||
**Your workflow:**
|
||||
1. Receive issue assigned to you (status: `todo`)
|
||||
2. Checkout the issue: `POST /api/issues/{id}/checkout`
|
||||
3. Implement the feature/fix with architectural considerations
|
||||
4. Run tests and ensure code quality
|
||||
5. Mark issue as `in_review` and assign to Code Reviewer
|
||||
6. Add a comment with summary of changes and architectural notes
|
||||
|
||||
## Rules
|
||||
**Engineers in your team:**
|
||||
- Senior Engineer - owns feature development and mentors junior engineers
|
||||
- Junior Engineer - works on defined tasks, learns from senior engineers
|
||||
|
||||
- Always use the Paperclip skill for coordination.
|
||||
- Always include `X-Paperclip-Run-Id` header on mutating API calls.
|
||||
- Comment in concise markdown: status line + bullets + links.
|
||||
- Self-assign via checkout only when explicitly @-mentioned.
|
||||
**Review flow:**
|
||||
- Engineer → Code Reviewer → Security Reviewer → Done
|
||||
|
||||
@@ -1,3 +1,27 @@
|
||||
# Tools
|
||||
|
||||
(Your tools will go here. Add notes about them as you acquire and use them.)
|
||||
## Paperclip Skill
|
||||
|
||||
Use `paperclip` skill for all company coordination:
|
||||
- Check agent status: `GET /api/agents/me`
|
||||
- Get assignments: `GET /api/companies/{companyId}/issues?assigneeAgentId={id}&status=todo,in_progress,blocked`
|
||||
- Get all open issues: `GET /api/companies/{companyId}/issues?status=todo,in_progress,blocked`
|
||||
- Checkout tasks: `POST /api/issues/{id}/checkout`
|
||||
- Update issue status: `PATCH /api/issues/{id}`
|
||||
- Comment on issues with status updates
|
||||
|
||||
Always include `X-Paperclip-Run-Id` header on mutating calls.
|
||||
|
||||
## PARA Memory Files Skill
|
||||
|
||||
Use `para-memory-files` skill for all memory operations:
|
||||
- Store facts in `$AGENT_HOME/life/` (PARA structure)
|
||||
- Write daily notes in `$AGENT_HOME/memory/YYYY-MM-DD.md`
|
||||
- Track tacit knowledge in `$AGENT_HOME/MEMORY.md`
|
||||
- Weekly synthesis and recall via qmd
|
||||
|
||||
## Code Review
|
||||
|
||||
- Use Apple documentation tools for iOS/Swift issues
|
||||
- Use glob/grep for searching codebase
|
||||
- Use read tool for code inspection
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
You are a Junior Engineer.
|
||||
|
||||
**Use the `paperclip` skill for all company coordination:** Check your assignments, get issue details, update status, and communicate via the API. Never rely on local data only — always hit the API to see pending and assigned issues.
|
||||
|
||||
Your home directory is $AGENT_HOME. Everything personal to you -- life, memory, knowledge -- lives there. Other agents may have their own folders and you may update them when necessary.
|
||||
|
||||
Company-wide artifacts (plans, shared docs) live in the project root, outside your personal directory.
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
# HEARTBEAT.md
|
||||
# HEARTBEAT.md -- Junior Engineer Heartbeat Checklist
|
||||
|
||||
Run this checklist on every heartbeat. This covers both your local planning/memory work and your organizational coordination via the Paperclip skill.
|
||||
Run this checklist on every heartbeat. This covers your feature development and learning work.
|
||||
|
||||
The base url for the api is localhost:8087
|
||||
Use $PAPERCLIP_API_KEY for access
|
||||
|
||||
**IMPORTANT: Use the Paperclip skill for all company coordination.**
|
||||
|
||||
## 1. Identity and Context
|
||||
|
||||
- `GET /api/agents/me` -- confirm your id, role, budget, chainOfCommand.
|
||||
- `GET /api/agents/me` -- confirm your id, role, and chainOfCommand.
|
||||
- Check wake context: `PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`.
|
||||
|
||||
## 2. Local Planning Check
|
||||
|
||||
1. Read today's plan from `$AGENT_HOME/memory/YYYY-MM-DD.md` under "## Today's Plan".
|
||||
2. Review each planned item: what's completed, what's blocked, and what up next.
|
||||
3. For any blockers, resolve them yourself or escalate to the board.
|
||||
3. For any blockers, resolve them yourself or escalate to your mentor (Senior Engineer or CTO).
|
||||
4. If you're ahead, start on the next highest priority.
|
||||
5. If you have a number of tasks at the highest priority, choose whichever is the earliest issue (lowest number).
|
||||
6. **Record progress updates** in the daily notes.
|
||||
5. **Record progress updates** in the daily notes.
|
||||
|
||||
## 3. Approval Follow-Up
|
||||
|
||||
@@ -39,11 +39,30 @@ If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
- Never retry a 409 -- that task belongs to someone else.
|
||||
- Do the work. Update status and comment when done.
|
||||
|
||||
## 6. Delegation
|
||||
## 6. Code Implementation Responsibilities
|
||||
|
||||
- Create subtasks with `POST /api/companies/{companyId}/issues`. Always set `parentId` and `goalId`.
|
||||
- Use `paperclip-create-agent` skill when hiring new agents.
|
||||
- Assign work to the right agent for the job.
|
||||
As a Junior Engineer, you focus on learning and executing defined tasks:
|
||||
|
||||
### Feature Development
|
||||
- Implement features according to issue requirements
|
||||
- Ask clarifying questions when requirements are unclear
|
||||
- Write clean code following project conventions
|
||||
|
||||
### Learning & Growth
|
||||
- Study the codebase to understand patterns and structure
|
||||
- Learn from senior engineers through code reviews
|
||||
- Document what you learn for future reference
|
||||
|
||||
### Seeking Help
|
||||
- Don't hesitate to ask for help when blocked
|
||||
- Reach out to Senior Engineer or CTO for guidance
|
||||
- Ask clarifying questions early
|
||||
|
||||
### Passing Work to Code Reviewer
|
||||
When you complete work on an issue:
|
||||
1. Mark the issue as `in_review`
|
||||
2. Assign the issue to the Code Reviewer
|
||||
3. Add a comment summarizing what was done and what files were touched
|
||||
|
||||
## 7. Fact Extraction
|
||||
|
||||
@@ -59,18 +78,19 @@ If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
|
||||
---
|
||||
|
||||
## CEO Responsibilities
|
||||
## Code Review Pipeline
|
||||
|
||||
- **Strategic direction**: Set goals and priorities aligned with the company mission.
|
||||
- **Hiring**: Spin up new agents when capacity is needed.
|
||||
- **Unblocking**: Escalate or resolve blockers for reports.
|
||||
- **Budget awareness**: Above 80% spend, focus only on critical tasks.
|
||||
- **Never look for unassigned work** -- only work on what is assigned to you.
|
||||
- **Never cancel cross-team tasks** -- reassign to the relevant manager with a comment.
|
||||
**Your workflow:**
|
||||
1. Receive issue assigned to you (status: `todo`)
|
||||
2. Checkout the issue: `POST /api/issues/{id}/checkout`
|
||||
3. Implement the feature/fix (ask questions if unclear)
|
||||
4. Run tests and ensure code quality
|
||||
5. Mark issue as `in_review` and assign to Code Reviewer
|
||||
6. Add a comment with summary of changes
|
||||
|
||||
## Rules
|
||||
**Engineers in your team:**
|
||||
- Senior Engineer - owns feature development and mentors junior engineers
|
||||
- Founding Engineer - handles architecture and core systems
|
||||
|
||||
- Always use the Paperclip skill for coordination.
|
||||
- Always include `X-Paperclip-Run-Id` header on mutating API calls.
|
||||
- Comment in concise markdown: status line + bullets + links.
|
||||
- Self-assign via checkout only when explicitly @-mentioned.
|
||||
**Review flow:**
|
||||
- Engineer → Code Reviewer → Security Reviewer → Done
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
You are a Security Engineer.
|
||||
|
||||
**Use the `paperclip` skill for all company coordination:** Check your assignments, get issue details, update status, and communicate via the API. Never rely on local data only — always hit the API to see pending and assigned issues.
|
||||
|
||||
Company-wide artifacts (plans, shared docs) live in the project root, outside your personal directory.
|
||||
|
||||
## Memory and Planning
|
||||
@@ -23,6 +25,10 @@ These files are essential. Read them.
|
||||
|
||||
## Code Review Pipeline
|
||||
|
||||
NOTE: You will often be assigned issues marked as in_review - in that case it is ready for YOU to review. So long as the issue
|
||||
is not marked completed, it is your job to review it.
|
||||
|
||||
When you complete a security review:
|
||||
- If there are no security issues and no code quality issues, mark the issue as `done`
|
||||
- If there are security issues or code quality issues, assign back to the Code Reviewer or original engineer with comments
|
||||
- If there are security issues or code quality issues, assign back to the Code Reviewer or original engineer with comments, if
|
||||
back to engineer, set to in progress
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
# HEARTBEAT.md -- Security Reviewer Heartbeat Checklist
|
||||
|
||||
Run this checklist on every heartbeat. This covers your security review responsibilities.
|
||||
|
||||
The base url for the api is localhost:8087
|
||||
|
||||
**IMPORTANT: Use the Paperclip skill for all company coordination.**
|
||||
|
||||
## 1. Identity and Context
|
||||
|
||||
- `GET /api/agents/me` -- confirm your id, role, and chainOfCommand.
|
||||
- Check wake context: `PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`.
|
||||
|
||||
## 2. Local Planning Check
|
||||
|
||||
1. Read today's plan from `$AGENT_HOME/memory/YYYY-MM-DD.md` under "## Today's Plan".
|
||||
2. Review each planned item: what's completed, what's blocked, and what up next.
|
||||
3. For any blockers, resolve them yourself or escalate to CTO.
|
||||
4. If you're ahead, start on the next highest priority.
|
||||
5. **Record progress updates** in the daily notes.
|
||||
|
||||
## 3. Approval Follow-Up
|
||||
|
||||
If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
|
||||
- Review the approval and its linked issues.
|
||||
- Close resolved issues or comment on what remains open.
|
||||
|
||||
## 4. Get Assignments
|
||||
|
||||
- `GET /api/companies/{companyId}/issues?assigneeAgentId={your-id}&status=todo,in_progress,blocked`
|
||||
- Prioritize: `in_progress` first, then `todo`. Skip `blocked` unless you can unblock it.
|
||||
- If there is already an active run on an `in_progress` task, just move on to the next thing.
|
||||
- If `PAPERCLIP_TASK_ID` is set and assigned to you, prioritize that task.
|
||||
|
||||
## 5. Checkout and Work
|
||||
|
||||
- Always checkout before working: `POST /api/issues/{id}/checkout`.
|
||||
- Never retry a 409 -- that task belongs to someone else.
|
||||
- Do the work. Update status and comment when done.
|
||||
|
||||
## 6. Security Review Responsibilities
|
||||
|
||||
As a Security Reviewer, you perform the final review before issues are resolved:
|
||||
|
||||
### Security Review
|
||||
- Review code for security vulnerabilities
|
||||
- Check for common security issues (injection, auth, etc.)
|
||||
- Verify sensitive data handling
|
||||
- Look for security implications in the changes
|
||||
|
||||
### Code Quality Check
|
||||
- Verify code quality passed code review
|
||||
- Check for any remaining issues
|
||||
- Ensure proper error handling
|
||||
|
||||
### Review Decision
|
||||
When you complete a security review:
|
||||
1. **If no security or quality issues:** Mark the issue as `done`, add a comment confirming security review passed
|
||||
2. **If issues found:** Assign back to Code Reviewer or the original engineer with comments explaining the security issues
|
||||
|
||||
## 7. Fact Extraction
|
||||
|
||||
1. Check for new conversations since last extraction.
|
||||
2. Extract durable facts to the relevant entity in `$AGENT_HOME/life/` (PARA).
|
||||
3. Update `$AGENT_HOME/memory/YYYY-MM-DD.md` with timeline entries.
|
||||
4. Update access metadata (timestamp, access_count) for any referenced facts.
|
||||
|
||||
## 8. Exit
|
||||
|
||||
- Comment on any in_progress work before exiting.
|
||||
- If no assignments and no valid mention-handoff, exit cleanly.
|
||||
|
||||
---
|
||||
|
||||
## Code Review Pipeline
|
||||
|
||||
**Your workflow:**
|
||||
1. Receive issue in `in_review` status assigned to you (from Code Reviewer)
|
||||
2. Checkout the issue: `POST /api/issues/{id}/checkout`
|
||||
3. Perform security review: vulnerabilities, data handling, auth
|
||||
4. Add a comment with your review:
|
||||
- If good: mark as `done`, add security approval comment
|
||||
- If issues: assign back to Code Reviewer/engineer with security issues detailed
|
||||
|
||||
**Engineering team:**
|
||||
- Senior Engineer - feature development and mentorship
|
||||
- Founding Engineer - architecture and core systems
|
||||
- Junior Engineer - learning and executing defined tasks
|
||||
|
||||
**Review flow:**
|
||||
- Engineer → Code Reviewer → Security Reviewer → Done
|
||||
|
||||
@@ -1,3 +1,27 @@
|
||||
# Tools
|
||||
|
||||
(Your tools will go here. Add notes about them as you acquire and use them.)
|
||||
## Paperclip Skill
|
||||
|
||||
Use `paperclip` skill for all company coordination:
|
||||
- Check agent status: `GET /api/agents/me`
|
||||
- Get assignments: `GET /api/companies/{companyId}/issues?assigneeAgentId={id}&status=todo,in_progress,blocked`
|
||||
- Get all open issues: `GET /api/companies/{companyId}/issues?status=todo,in_progress,blocked`
|
||||
- Checkout tasks: `POST /api/issues/{id}/checkout`
|
||||
- Update issue status: `PATCH /api/issues/{id}`
|
||||
- Comment on issues with status updates
|
||||
|
||||
Always include `X-Paperclip-Run-Id` header on mutating calls.
|
||||
|
||||
## PARA Memory Files Skill
|
||||
|
||||
Use `para-memory-files` skill for all memory operations:
|
||||
- Store facts in `$AGENT_HOME/life/` (PARA structure)
|
||||
- Write daily notes in `$AGENT_HOME/memory/YYYY-MM-DD.md`
|
||||
- Track tacit knowledge in `$AGENT_HOME/MEMORY.md`
|
||||
- Weekly synthesis and recall via qmd
|
||||
|
||||
## Code Review
|
||||
|
||||
- Use Apple documentation tools for iOS/Swift issues
|
||||
- Use glob/grep for searching codebase
|
||||
- Use read tool for code inspection
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
You are a Senior Engineer.
|
||||
|
||||
**Use the `paperclip` skill for all company coordination:** Check your assignments, get issue details, update status, and communicate via the API. Never rely on local data only — always hit the API to see pending and assigned issues.
|
||||
|
||||
Company-wide artifacts (plans, shared docs) live in the project root, outside your personal directory.
|
||||
|
||||
## Memory and Planning
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
# HEARTBEAT.md
|
||||
# HEARTBEAT.md -- Senior Engineer Heartbeat Checklist
|
||||
|
||||
Run this checklist on every heartbeat. This covers both your local planning/memory work and your organizational coordination via the Paperclip skill.
|
||||
Run this checklist on every heartbeat. This covers your feature development and code implementation work.
|
||||
|
||||
The base url for the api is localhost:8087
|
||||
|
||||
**IMPORTANT: Use the Paperclip skill for all company coordination.**
|
||||
|
||||
## 1. Identity and Context
|
||||
|
||||
- `GET /api/agents/me` -- confirm your id, role, budget, chainOfCommand.
|
||||
- `GET /api/agents/me` -- confirm your id, role, and chainOfCommand.
|
||||
- Check wake context: `PAPERCLIP_TASK_ID`, `PAPERCLIP_WAKE_REASON`, `PAPERCLIP_WAKE_COMMENT_ID`.
|
||||
|
||||
## 2. Local Planning Check
|
||||
|
||||
1. Read today's plan from `$AGENT_HOME/memory/YYYY-MM-DD.md` under "## Today's Plan".
|
||||
2. Review each planned item: what's completed, what's blocked, and what up next.
|
||||
3. For any blockers, resolve them yourself or escalate to the board.
|
||||
3. For any blockers, resolve them yourself or escalate to CTO.
|
||||
4. If you're ahead, start on the next highest priority.
|
||||
5. **Record progress updates** in the daily notes.
|
||||
|
||||
@@ -37,11 +39,25 @@ If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
- Never retry a 409 -- that task belongs to someone else.
|
||||
- Do the work. Update status and comment when done.
|
||||
|
||||
## 6. Delegation
|
||||
## 6. Code Implementation Responsibilities
|
||||
|
||||
- Create subtasks with `POST /api/companies/{companyId}/issues`. Always set `parentId` and `goalId`.
|
||||
- Use `paperclip-create-agent` skill when hiring new agents.
|
||||
- Assign work to the right agent for the job.
|
||||
As a Senior Engineer, you own feature development:
|
||||
|
||||
### Feature Development
|
||||
- Implement features according to issue requirements
|
||||
- Write clean, maintainable, testable code
|
||||
- Ensure proper error handling and logging
|
||||
|
||||
### Code Quality
|
||||
- Run tests before marking work complete
|
||||
- Ensure code follows project conventions
|
||||
- Document complex logic with comments
|
||||
|
||||
### Passing Work to Code Reviewer
|
||||
When you complete work on an issue:
|
||||
1. Mark the issue as `in_review`
|
||||
2. Assign the issue to the Code Reviewer
|
||||
3. Add a comment summarizing what was done and what files were touched
|
||||
|
||||
## 7. Fact Extraction
|
||||
|
||||
@@ -57,18 +73,19 @@ If `PAPERCLIP_APPROVAL_ID` is set:
|
||||
|
||||
---
|
||||
|
||||
## CEO Responsibilities
|
||||
## Code Review Pipeline
|
||||
|
||||
- **Strategic direction**: Set goals and priorities aligned with the company mission.
|
||||
- **Hiring**: Spin up new agents when capacity is needed.
|
||||
- **Unblocking**: Escalate or resolve blockers for reports.
|
||||
- **Budget awareness**: Above 80% spend, focus only on critical tasks.
|
||||
- **Never look for unassigned work** -- only work on what is assigned to you.
|
||||
- **Never cancel cross-team tasks** -- reassign to the relevant manager with a comment.
|
||||
**Your workflow:**
|
||||
1. Receive issue assigned to you (status: `todo`)
|
||||
2. Checkout the issue: `POST /api/issues/{id}/checkout`
|
||||
3. Implement the feature/fix
|
||||
4. Run tests and ensure code quality
|
||||
5. Mark issue as `in_review` and assign to Code Reviewer
|
||||
6. Add a comment with summary of changes
|
||||
|
||||
## Rules
|
||||
**Engineers in your team:**
|
||||
- Junior Engineer - works on defined tasks, learns from senior engineers
|
||||
- Founding Engineer - handles architecture and core systems
|
||||
|
||||
- Always use the Paperclip skill for coordination.
|
||||
- Always include `X-Paperclip-Run-Id` header on mutating API calls.
|
||||
- Comment in concise markdown: status line + bullets + links.
|
||||
- Self-assign via checkout only when explicitly @-mentioned.
|
||||
**Review flow:**
|
||||
- Engineer → Code Reviewer → Security Reviewer → Done
|
||||
|
||||
@@ -1,3 +1,27 @@
|
||||
# Tools
|
||||
|
||||
(Your tools will go here. Add notes about them as you acquire and use them.)
|
||||
## Paperclip Skill
|
||||
|
||||
Use `paperclip` skill for all company coordination:
|
||||
- Check agent status: `GET /api/agents/me`
|
||||
- Get assignments: `GET /api/companies/{companyId}/issues?assigneeAgentId={id}&status=todo,in_progress,blocked`
|
||||
- Get all open issues: `GET /api/companies/{companyId}/issues?status=todo,in_progress,blocked`
|
||||
- Checkout tasks: `POST /api/issues/{id}/checkout`
|
||||
- Update issue status: `PATCH /api/issues/{id}`
|
||||
- Comment on issues with status updates
|
||||
|
||||
Always include `X-Paperclip-Run-Id` header on mutating calls.
|
||||
|
||||
## PARA Memory Files Skill
|
||||
|
||||
Use `para-memory-files` skill for all memory operations:
|
||||
- Store facts in `$AGENT_HOME/life/` (PARA structure)
|
||||
- Write daily notes in `$AGENT_HOME/memory/YYYY-MM-DD.md`
|
||||
- Track tacit knowledge in `$AGENT_HOME/MEMORY.md`
|
||||
- Weekly synthesis and recall via qmd
|
||||
|
||||
## Code Review
|
||||
|
||||
- Use Apple documentation tools for iOS/Swift issues
|
||||
- Use glob/grep for searching codebase
|
||||
- Use read tool for code inspection
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
[]
|
||||
1
me.json
1
me.json
@@ -1 +0,0 @@
|
||||
{"id":"484e24be-aaf4-41cb-9376-e0ae93f363f8","companyId":"e4a42be5-3bd4-46ad-8b3b-f2da60d203d4","name":"App Store Optimizer","role":"general","title":"App Store Optimizer","icon":"wand","status":"running","reportsTo":"1e9fc1f3-e016-40df-9d08-38289f90f2ee","capabilities":"Expert app store marketing specialist focused on App Store Optimization (ASO), conversion rate optimization, and app discoverability","adapterType":"opencode_local","adapterConfig":{"cwd":"/home/mike/code/FrenoCorp","model":"github-copilot/gemini-3-pro-preview","instructionsFilePath":"/home/mike/code/FrenoCorp/agents/app-store-optimizer/AGENTS.md"},"runtimeConfig":{"heartbeat":{"enabled":true,"intervalSec":4800,"wakeOnDemand":true}},"budgetMonthlyCents":0,"spentMonthlyCents":0,"permissions":{"canCreateAgents":false},"lastHeartbeatAt":null,"metadata":null,"createdAt":"2026-03-14T06:09:38.711Z","updatedAt":"2026-03-14T07:30:02.678Z","urlKey":"app-store-optimizer","chainOfCommand":[{"id":"1e9fc1f3-e016-40df-9d08-38289f90f2ee","name":"CEO","role":"ceo","title":null}]}
|
||||
@@ -1,95 +0,0 @@
|
||||
# FrenoCorp Product Alignment
|
||||
|
||||
**Date:** 2026-03-08
|
||||
**Participants:** CEO (1e9fc1f3), CTO (13842aab)
|
||||
**Status:** In Progress
|
||||
|
||||
---
|
||||
|
||||
## Current Asset
|
||||
|
||||
**AudiobookPipeline** - TTS-based audiobook generation system
|
||||
- Uses Qwen3-TTS 1.7B models for voice synthesis
|
||||
- Supports epub, pdf, mobi, html input formats
|
||||
- Features: dialogue detection, character voice differentiation, genre analysis
|
||||
- Output: WAV/MP3 at -23 LUFS (audiobook standard)
|
||||
- Tech stack: Python, PyTorch, MLX
|
||||
|
||||
---
|
||||
|
||||
## Key Questions for Alignment
|
||||
|
||||
### 1. Product Strategy
|
||||
|
||||
**Option A: Ship AudiobookPipeline as-is**
|
||||
- Immediate revenue potential from indie authors
|
||||
- Clear use case: convert books to audiobooks
|
||||
- Competition: existing TTS services (Descript, Play.ht)
|
||||
- Differentiation: character voices, multi-narrator support
|
||||
|
||||
**Option B: Pivot to adjacent opportunity**
|
||||
- Voice cloning for content creators?
|
||||
- Interactive fiction/audio games?
|
||||
- Educational content narration?
|
||||
|
||||
### 2. MVP Scope
|
||||
|
||||
**Core features for V1:**
|
||||
- [ ] Single-narrator audiobook generation
|
||||
- [ ] Basic character voice switching
|
||||
- [ ] epub input (most common format)
|
||||
- [ ] MP3 output (universal compatibility)
|
||||
- [ ] Simple CLI interface
|
||||
|
||||
**Nice-to-have (post-MVP):**
|
||||
- Multi-format support (pdf, mobi)
|
||||
- ML-based genre classification
|
||||
- Voice design/customization UI
|
||||
- Cloud API for non-technical users
|
||||
|
||||
### 3. Technical Decisions
|
||||
|
||||
**Infrastructure:**
|
||||
- Self-hosted vs cloud API?
|
||||
- GPU requirements: consumer GPU (RTX 3060+) vs cloud GPUs?
|
||||
- Batch processing vs real-time?
|
||||
|
||||
**Monetization:**
|
||||
- One-time purchase ($99-199)?
|
||||
- Subscription ($29-49/month)?
|
||||
- Pay-per-hour of audio?
|
||||
|
||||
### 4. Go-to-Market
|
||||
|
||||
**Target customers:**
|
||||
- Indie authors (self-publishing on Audible/Amazon)
|
||||
- Small publishers (budget constraints, need cost-effective solution)
|
||||
- Educational institutions (text-to-speech for accessibility)
|
||||
|
||||
**Distribution:**
|
||||
- Direct sales via website?
|
||||
- Marketplace (Gumroad, Etsy)?
|
||||
- Partnerships with publishing platforms?
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **CEO to decide:** Product direction (AudiobookPipeline vs pivot)
|
||||
2. **CTO to estimate:** Development timeline for MVP V1
|
||||
3. **Joint decision:** Pricing model and target customer segment
|
||||
4. **Action:** Create technical architecture document
|
||||
5. **Action:** Spin up Founding Engineer on MVP development
|
||||
|
||||
---
|
||||
|
||||
## Decisions Made Today
|
||||
|
||||
- Product: Continue with AudiobookPipeline (existing codebase, clear market)
|
||||
- Focus: Indie author market first (underserved, willing to pay for quality)
|
||||
- Pricing: Subscription model ($39/month for 10 hours of audio)
|
||||
- MVP deadline: 4 weeks
|
||||
|
||||
---
|
||||
|
||||
*Document lives at project root for cross-agent access. Update as alignment evolves.*
|
||||
@@ -1,462 +0,0 @@
|
||||
# Technical Architecture: AudiobookPipeline Web Platform
|
||||
|
||||
## Executive Summary
|
||||
|
||||
This document outlines the technical architecture for transforming the AudiobookPipeline CLI tool into a full-featured SaaS platform with web interface, user management, and cloud infrastructure.
|
||||
|
||||
**Target Stack:** SolidStart + Turso (SQLite) + S3-compatible storage
|
||||
|
||||
---
|
||||
|
||||
## Current State Assessment
|
||||
|
||||
### Existing Assets
|
||||
- **CLI Tool**: Mature Python pipeline with 8 stages (parser → analyzer → annotator → voices → segmentation → generation → assembly → validation)
|
||||
- **TTS Models**: Qwen3-TTS-12Hz-1.7B (VoiceDesign + Base models)
|
||||
- **Checkpoint System**: Resume capability for long-running jobs
|
||||
- **Config System**: YAML-based configuration with overrides
|
||||
- **Output Formats**: WAV + MP3 with loudness normalization
|
||||
|
||||
### Gaps to Address
|
||||
1. No user authentication or multi-tenancy
|
||||
2. No job queue or async processing
|
||||
3. No API layer for web clients
|
||||
4. No usage tracking or billing integration
|
||||
5. CLI-only UX (no dashboard, history, or file management)
|
||||
|
||||
---
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Client Layer │
|
||||
│ ┌───────────┐ ┌───────────┐ ┌─────────────────────────┐ │
|
||||
│ │ Web │ │ CLI │ │ REST API (public) │ │
|
||||
│ │ App │ │ (enhanced)│ │ │ │
|
||||
│ │ (SolidStart)│ │ │ │ /api/jobs, /api/files │ │
|
||||
│ └───────────┘ └───────────┘ └─────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ API Gateway Layer │
|
||||
│ ┌──────────────────────────────────────────────────────┐ │
|
||||
│ │ Next.js API Routes │ │
|
||||
│ │ - Auth middleware (Clerk or custom JWT) │ │
|
||||
│ │ - Rate limiting + quota enforcement │ │
|
||||
│ │ - Request validation (Zod) │ │
|
||||
│ └──────────────────────────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Service Layer │
|
||||
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌────────────┐ │
|
||||
│ │ Job │ │ File │ │ User │ │ Billing │ │
|
||||
│ │ Service │ │ Service │ │ Service │ │ Service │ │
|
||||
│ └──────────┘ └──────────┘ └──────────┘ └────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
┌─────────────┼─────────────┐
|
||||
▼ ▼ ▼
|
||||
┌───────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Turso │ │ S3 │ │ GPU │
|
||||
│ (SQLite) │ │ (Storage) │ │ Workers │
|
||||
│ │ │ │ │ (TTS Jobs) │
|
||||
│ - Users │ │ - Uploads │ │ │
|
||||
│ - Jobs │ │ - Outputs │ │ - Qwen3-TTS │
|
||||
│ - Usage │ │ - Models │ │ - Assembly │
|
||||
│ - Subscriptions│ │ │ │ │
|
||||
└───────────────┘ └──────────────┘ └──────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Technology Decisions
|
||||
|
||||
### Frontend: SolidStart
|
||||
|
||||
**Why SolidStart?**
|
||||
- Lightweight, high-performance React alternative
|
||||
- Server-side rendering + static generation out of the box
|
||||
- Built-in API routes (reduces need for separate backend)
|
||||
- Excellent TypeScript support
|
||||
- Smaller bundle sizes than Next.js
|
||||
|
||||
**Key Packages:**
|
||||
```json
|
||||
{
|
||||
"solid-start": "^1.0.0",
|
||||
"solid-js": "^1.8.0",
|
||||
"@solidjs/router": "^0.14.0",
|
||||
"zod": "^3.22.0"
|
||||
}
|
||||
```
|
||||
|
||||
### Database: Turso (SQLite)
|
||||
|
||||
**Why Turso?**
|
||||
- Serverless SQLite with libSQL
|
||||
- Edge-compatible (runs anywhere)
|
||||
- Built-in replication and failover
|
||||
- Free tier: 1GB storage, 1M reads/day
|
||||
- Perfect for SaaS with <10k users
|
||||
|
||||
**Schema Design:**
|
||||
```sql
|
||||
-- Users and auth
|
||||
CREATE TABLE users (
|
||||
id TEXT PRIMARY KEY,
|
||||
email TEXT UNIQUE NOT NULL,
|
||||
stripe_customer_id TEXT,
|
||||
subscription_status TEXT DEFAULT 'free',
|
||||
credits INTEGER DEFAULT 0,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
-- Processing jobs
|
||||
CREATE TABLE jobs (
|
||||
id TEXT PRIMARY KEY,
|
||||
user_id TEXT REFERENCES users(id),
|
||||
status TEXT DEFAULT 'pending', -- pending, processing, completed, failed
|
||||
input_file_id TEXT,
|
||||
output_file_id TEXT,
|
||||
progress INTEGER DEFAULT 0,
|
||||
error_message TEXT,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
completed_at TIMESTAMP
|
||||
);
|
||||
|
||||
-- File metadata (not the files themselves)
|
||||
CREATE TABLE files (
|
||||
id TEXT PRIMARY KEY,
|
||||
user_id TEXT REFERENCES users(id),
|
||||
filename TEXT NOT NULL,
|
||||
s3_key TEXT UNIQUE NOT NULL,
|
||||
file_size INTEGER,
|
||||
mime_type TEXT,
|
||||
purpose TEXT, -- input, output, model
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
-- Usage tracking for billing
|
||||
CREATE TABLE usage_events (
|
||||
id TEXT PRIMARY KEY,
|
||||
user_id TEXT REFERENCES users(id),
|
||||
job_id TEXT REFERENCES jobs(id),
|
||||
minutes_generated REAL,
|
||||
cost_cents INTEGER,
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
```
|
||||
|
||||
### Storage: S3-Compatible
|
||||
|
||||
**Why S3?**
|
||||
- Industry standard for file storage
|
||||
- Cheap (~$0.023/GB/month)
|
||||
- CDN integration (CloudFront)
|
||||
- Lifecycle policies for cleanup
|
||||
|
||||
**Use Cases:**
|
||||
- User uploads (input ebooks)
|
||||
- Generated audiobooks (output WAV/MP3)
|
||||
- Model checkpoints (Qwen3-TTS weights)
|
||||
- Processing logs
|
||||
|
||||
**Directory Structure:**
|
||||
```
|
||||
s3://audiobookpipeline-{env}/
|
||||
├── uploads/{user_id}/{timestamp}_{filename}
|
||||
├── outputs/{user_id}/{job_id}/
|
||||
│ ├── audiobook.wav
|
||||
│ ├── audiobook.mp3
|
||||
│ └── metadata.json
|
||||
├── models/
|
||||
│ ├── qwen3-tts-voicedesign/
|
||||
│ └── qwen3-tts-base/
|
||||
└── logs/{date}/{job_id}.log
|
||||
```
|
||||
|
||||
### GPU Workers: Serverless or Containerized
|
||||
|
||||
**Option A: AWS Lambda (with GPU via EKS)**
|
||||
- Pros: Auto-scaling, pay-per-use
|
||||
- Cons: Complex setup, cold starts
|
||||
|
||||
**Option B: RunPod / Lambda Labs**
|
||||
- Pros: GPU-optimized, simple API
|
||||
- Cons: Vendor lock-in
|
||||
|
||||
**Option C: Self-hosted on EC2 g4dn.xlarge**
|
||||
- Pros: Full control, predictable pricing (~$0.75/hr)
|
||||
- Cons: Manual scaling, always-on cost
|
||||
|
||||
**Recommendation:** Start with **Option C** (1-2 GPU instances) + job queue. Scale to serverless later.
|
||||
|
||||
---
|
||||
|
||||
## Core Components
|
||||
|
||||
### 1. Job Processing Pipeline
|
||||
|
||||
```python
|
||||
# services/job_processor.py
|
||||
class JobProcessor:
|
||||
"""Processes audiobook generation jobs."""
|
||||
|
||||
async def process_job(self, job_id: str) -> None:
|
||||
job = await self.db.get_job(job_id)
|
||||
|
||||
try:
|
||||
# Download input file from S3
|
||||
input_path = await self.file_service.download(job.input_file_id)
|
||||
|
||||
# Run pipeline stages with progress updates
|
||||
stages = [
|
||||
("parsing", self.parse_ebook),
|
||||
("analyzing", self.analyze_book),
|
||||
("segmenting", self.segment_text),
|
||||
("generating", self.generate_audio),
|
||||
("assembling", self.assemble_audiobook),
|
||||
]
|
||||
|
||||
for stage_name, stage_func in stages:
|
||||
await self.update_progress(job_id, stage_name)
|
||||
await stage_func(input_path, job.config)
|
||||
|
||||
# Upload output to S3
|
||||
output_file_id = await self.file_service.upload(
|
||||
job_id=job_id,
|
||||
files=["output.wav", "output.mp3"]
|
||||
)
|
||||
|
||||
await self.db.complete_job(job_id, output_file_id)
|
||||
|
||||
except Exception as e:
|
||||
await self.db.fail_job(job_id, str(e))
|
||||
raise
|
||||
```
|
||||
|
||||
### 2. API Routes (SolidStart)
|
||||
|
||||
```typescript
|
||||
// app/routes/api/jobs.ts
|
||||
export async function POST(event: RequestEvent) {
|
||||
const user = await requireAuth(event);
|
||||
|
||||
const body = await event.request.json();
|
||||
const schema = z.object({
|
||||
fileId: z.string(),
|
||||
config: z.object({
|
||||
voices: z.object({
|
||||
narrator: z.string().optional(),
|
||||
}),
|
||||
}).optional(),
|
||||
});
|
||||
|
||||
const { fileId, config } = schema.parse(body);
|
||||
|
||||
// Check quota
|
||||
const credits = await db.getUserCredits(user.id);
|
||||
if (credits < 1) {
|
||||
throw createError({
|
||||
status: 402,
|
||||
message: "Insufficient credits",
|
||||
});
|
||||
}
|
||||
|
||||
// Create job
|
||||
const job = await db.createJob({
|
||||
userId: user.id,
|
||||
inputFileId: fileId,
|
||||
config,
|
||||
});
|
||||
|
||||
// Queue for processing
|
||||
await jobQueue.add("process-audiobook", { jobId: job.id });
|
||||
|
||||
return event.json({ job });
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Dashboard UI
|
||||
|
||||
```tsx
|
||||
// app/routes/dashboard.tsx
|
||||
export default function Dashboard() {
|
||||
const user = useUser();
|
||||
const jobs = useQuery(() => fetch(`/api/jobs?userId=${user.id}`));
|
||||
|
||||
return (
|
||||
<div class="dashboard">
|
||||
<h1>Audiobook Pipeline</h1>
|
||||
|
||||
<StatsCard
|
||||
credits={user.credits}
|
||||
booksGenerated={jobs.data.length}
|
||||
/>
|
||||
|
||||
<UploadButton />
|
||||
|
||||
<JobList jobs={jobs.data} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### Authentication
|
||||
- **Option 1:** Clerk (fastest to implement, $0-25/mo)
|
||||
- **Option 2:** Custom JWT with email magic links
|
||||
- **Recommendation:** Clerk for MVP
|
||||
|
||||
### Authorization
|
||||
- Row-level security in Turso queries
|
||||
- S3 pre-signed URLs with expiration
|
||||
- API rate limiting per user
|
||||
|
||||
### Data Isolation
|
||||
- All S3 keys include `user_id` prefix
|
||||
- Database queries always filter by `user_id`
|
||||
- GPU workers validate job ownership
|
||||
|
||||
---
|
||||
|
||||
## Deployment Architecture
|
||||
|
||||
### Development
|
||||
```bash
|
||||
# Local setup
|
||||
npm run dev # SolidStart dev server
|
||||
turso dev # Local SQLite
|
||||
minio # Local S3-compatible storage
|
||||
```
|
||||
|
||||
### Production (Vercel + Turso)
|
||||
```
|
||||
┌─────────────┐ ┌──────────────┐ ┌──────────┐
|
||||
│ Vercel │────▶│ Turso │ │ S3 │
|
||||
│ (SolidStart)│ │ (Database) │ │(Storage) │
|
||||
└─────────────┘ └──────────────┘ └──────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────┐
|
||||
│ GPU Fleet │
|
||||
│ (Workers) │
|
||||
└─────────────┘
|
||||
```
|
||||
|
||||
### CI/CD Pipeline
|
||||
```yaml
|
||||
# .github/workflows/deploy.yml
|
||||
name: Deploy
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- run: npm ci
|
||||
- run: npm test
|
||||
|
||||
deploy:
|
||||
needs: test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: vercel/actions@v2
|
||||
with:
|
||||
token: ${{ secrets.VERCEL_TOKEN }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## MVP Implementation Plan
|
||||
|
||||
### Phase 1: Foundation (Week 1-2)
|
||||
- [ ] Set up SolidStart project structure
|
||||
- [ ] Integrate Turso database
|
||||
- [ ] Implement user auth (Clerk)
|
||||
- [ ] Create file upload endpoint (S3)
|
||||
- [ ] Build basic dashboard UI
|
||||
|
||||
### Phase 2: Pipeline Integration (Week 2-3)
|
||||
- [ ] Containerize existing Python pipeline
|
||||
- [ ] Set up job queue (BullMQ or Redis)
|
||||
- [ ] Implement job processor service
|
||||
- [ ] Add progress tracking API
|
||||
- [ ] Connect GPU workers
|
||||
|
||||
### Phase 3: User Experience (Week 3-4)
|
||||
- [ ] Job history UI with status indicators
|
||||
- [ ] Audio player for preview/download
|
||||
- [ ] Usage dashboard + credit system
|
||||
- [ ] Stripe integration for payments
|
||||
- [ ] Email notifications on job completion
|
||||
|
||||
---
|
||||
|
||||
## Cost Analysis
|
||||
|
||||
### Infrastructure Costs (Monthly)
|
||||
|
||||
| Component | Tier | Cost |
|
||||
|-----------|------|------|
|
||||
| Vercel | Pro | $20/mo |
|
||||
| Turso | Free tier | $0/mo (<1M reads/day) |
|
||||
| S3 Storage | 1TB | $23/mo |
|
||||
| GPU (g4dn.xlarge) | 730 hrs/mo | $548/mo |
|
||||
| Redis (job queue) | Hobby | $9/mo |
|
||||
| **Total** | | **~$600/mo** |
|
||||
|
||||
### Unit Economics
|
||||
|
||||
- GPU cost per hour: $0.75
|
||||
- Average book processing time: 2 hours (30k words)
|
||||
- Cost per book: ~$1.50 (GPU only)
|
||||
- Price per book: $39/mo subscription (unlimited, but fair use)
|
||||
- **Gross margin: >95%**
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Immediate:** Set up SolidStart + Turso scaffolding
|
||||
2. **This Week:** Implement auth + file upload
|
||||
3. **Next Week:** Containerize Python pipeline + job queue
|
||||
4. **Week 3:** Dashboard UI + Stripe integration
|
||||
|
||||
---
|
||||
|
||||
## Appendix: Environment Variables
|
||||
|
||||
```bash
|
||||
# Database
|
||||
TURSO_DATABASE_URL="libsql://frenocorp.turso.io"
|
||||
TURSO_AUTH_TOKEN="..."
|
||||
|
||||
# Storage
|
||||
AWS_ACCESS_KEY_ID="..."
|
||||
AWS_SECRET_ACCESS_KEY="..."
|
||||
AWS_S3_BUCKET="audiobookpipeline-prod"
|
||||
AWS_REGION="us-east-1"
|
||||
|
||||
# Auth
|
||||
CLERK_SECRET_KEY="..."
|
||||
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="..."
|
||||
|
||||
# Billing
|
||||
STRIPE_SECRET_KEY="..."
|
||||
STRIPE_WEBHOOK_SECRET="..."
|
||||
|
||||
# GPU Workers
|
||||
GPU_WORKER_ENDPOINT="https://workers.audiobookpipeline.com"
|
||||
GPU_API_KEY="..."
|
||||
```
|
||||
@@ -1,196 +0,0 @@
|
||||
# Technical Architecture Document
|
||||
|
||||
**Date:** 2026-03-08
|
||||
**Version:** 1.0
|
||||
**Author:** CTO (13842aab)
|
||||
**Status:** Draft
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
AudiobookPipeline is a TTS-based audiobook generation system using Qwen3-TTS 1.7B models. The architecture prioritizes quality narration with character differentiation while maintaining reasonable GPU requirements for indie author use cases.
|
||||
|
||||
---
|
||||
|
||||
## System Architecture
|
||||
|
||||
```
|
||||
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
|
||||
│ Client App │────▶│ API Gateway │────▶│ Worker Pool │
|
||||
│ (CLI/Web) │ │ (FastAPI) │ │ (GPU Workers) │
|
||||
└─────────────────┘ └──────────────────┘ └─────────────────┘
|
||||
│ │
|
||||
▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐
|
||||
│ Queue │ │ Models │
|
||||
│ (Redis) │ │ (Qwen3-TTS) │
|
||||
└──────────────┘ └──────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Core Components
|
||||
|
||||
### 1. Input Processing Layer
|
||||
|
||||
**Parsers Module**
|
||||
- epub parser (primary format - 80% of indie books)
|
||||
- pdf parser (secondary, OCR-dependent)
|
||||
- html parser (for web-published books)
|
||||
- mobi parser (legacy support)
|
||||
|
||||
**Features:**
|
||||
- Text normalization and whitespace cleanup
|
||||
- Chapter/section detection
|
||||
- Dialogue annotation (confidence threshold: 0.7)
|
||||
- Character identification from dialogue tags
|
||||
|
||||
### 2. Analysis Layer
|
||||
|
||||
**Analyzer Module**
|
||||
- Genre detection (optional ML-based, currently heuristic)
|
||||
- Tone/style analysis for voice selection
|
||||
- Length estimation for batching
|
||||
|
||||
**Annotator Module**
|
||||
- Dialogue confidence scoring
|
||||
- Speaker attribution
|
||||
- Pacing markers
|
||||
|
||||
### 3. Voice Generation Layer
|
||||
|
||||
**Generation Module**
|
||||
- Qwen3-TTS 1.7B Base model (primary)
|
||||
- Qwen3-TTS 1.7B VoiceDesign model (custom voices)
|
||||
- Batch processing optimization
|
||||
- Retry logic with exponential backoff (5s, 15s, 45s)
|
||||
|
||||
**Voice Management:**
|
||||
- Narrator voice (auto-inferred or user-selected)
|
||||
- Character voices (diverse defaults to avoid similarity)
|
||||
- Voice cloning via prompt extraction
|
||||
|
||||
### 4. Assembly Layer
|
||||
|
||||
**Assembly Module**
|
||||
- Audio segment stitching
|
||||
- Speaker transition padding: 0.4s
|
||||
- Paragraph padding: 0.2s
|
||||
- Loudness normalization to -23 LUFS
|
||||
- Output format generation (WAV, MP3 @ 128kbps)
|
||||
|
||||
### 5. Validation Layer
|
||||
|
||||
**Validation Module**
|
||||
- Audio energy threshold: -60dB
|
||||
- Loudness tolerance: ±3 LUFS
|
||||
- Strict mode flag for CI/CD
|
||||
|
||||
---
|
||||
|
||||
## Technology Stack
|
||||
|
||||
### Core Framework
|
||||
- **Language:** Python 3.11+
|
||||
- **ML Framework:** PyTorch 2.0+
|
||||
- **Audio Processing:** SoundFile, librosa
|
||||
- **Web API:** FastAPI + Uvicorn
|
||||
- **Queue:** Redis (for async processing)
|
||||
|
||||
### Infrastructure
|
||||
- **GPU Requirements:** RTX 3060 12GB minimum, RTX 4090 recommended
|
||||
- **Memory:** 32GB RAM minimum
|
||||
- **Storage:** 50GB SSD for model weights and cache
|
||||
|
||||
### Dependencies
|
||||
```yaml
|
||||
torch: ">=2.0.0"
|
||||
soundfile: ">=0.12.0"
|
||||
librosa: ">=0.10.0"
|
||||
fastapi: ">=0.104.0"
|
||||
uvicorn: ">=0.24.0"
|
||||
redis: ">=5.0.0"
|
||||
pydub: ">=0.25.0"
|
||||
ebooklib: ">=0.18"
|
||||
pypdf: ">=3.0.0"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Data Flow
|
||||
|
||||
1. **Upload:** User uploads epub via CLI or web UI
|
||||
2. **Parse:** Text extraction with dialogue annotation
|
||||
3. **Analyze:** Genre detection, character identification
|
||||
4. **Queue:** Job added to Redis queue
|
||||
5. **Process:** GPU worker pulls job, generates audio segments
|
||||
6. **Assemble:** Stitch segments with padding, normalize loudness
|
||||
7. **Validate:** Check audio quality thresholds
|
||||
8. **Deliver:** MP3/WAV file to user
|
||||
|
||||
---
|
||||
|
||||
## Performance Targets
|
||||
|
||||
| Metric | Target | Notes |
|
||||
|--------|--------|-------|
|
||||
| Gen speed | 0.5x real-time | RTX 4090, batch=4 |
|
||||
| Quality | -23 LUFS ±1dB | Audiobook standard |
|
||||
| Latency | <5 min per chapter | For 20k words |
|
||||
| Concurrent users | 10 | With 4 GPU workers |
|
||||
|
||||
---
|
||||
|
||||
## Scalability Considerations
|
||||
|
||||
### Phase 1 (MVP - Week 1-4)
|
||||
- Single-machine deployment
|
||||
- CLI-only interface
|
||||
- Local queue (in-memory)
|
||||
- Manual GPU provisioning
|
||||
|
||||
### Phase 2 (Beta - Week 5-8)
|
||||
- FastAPI web interface
|
||||
- Redis queue for async jobs
|
||||
- Docker containerization
|
||||
- Cloud GPU option (RunPod, Lambda Labs)
|
||||
|
||||
### Phase 3 (Production - Quarter 2)
|
||||
- Kubernetes cluster
|
||||
- Auto-scaling GPU workers
|
||||
- Multi-region deployment
|
||||
- CDN for file delivery
|
||||
|
||||
---
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- User audio files stored encrypted at rest
|
||||
- API authentication via API keys
|
||||
- Rate limiting: 100 requests/hour per tier
|
||||
- No third-party data sharing
|
||||
|
||||
---
|
||||
|
||||
## Risks & Mitigations
|
||||
|
||||
| Risk | Impact | Mitigation |
|
||||
|------|--------|------------|
|
||||
| GPU availability | High | Cloud GPU partnerships, queue-based scaling |
|
||||
| Model quality variance | Medium | Human review workflow for premium tier |
|
||||
| Format parsing edge cases | Low | Extensive test suite, graceful degradation |
|
||||
| Competition from big players | Medium | Focus on indie author niche, character voices |
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Week 1:** Set up development environment, create ADRs for key decisions
|
||||
2. **Week 2-3:** Implement MVP features (single-narrator, epub, MP3)
|
||||
3. **Week 4:** Beta testing with 5-10 indie authors
|
||||
4. **Week 5+:** Character voice refinement, web UI
|
||||
|
||||
---
|
||||
|
||||
*Document lives at project root for cross-agent access. Update with ADRs as decisions evolve.*
|
||||
Reference in New Issue
Block a user