2.9 KiB
2.9 KiB
Index
PRD Epics and Stories
- Product Requirements Document (PRD) - The main PRD document, linking to individual epics.
- Epic 1: Project Initialization, Setup, and HN Content Acquisition
- Epic 2: Article Scraping
- Epic 3: AI-Powered Content Summarization
- Epic 4: Automated Newsletter Creation and Distribution
- Epic 5: Podcast Generation Integration
- Epic 6: Web Interface for Initial Structure and Content Access
Architecture Documents
- System Architecture Document - The main system architecture document, linking to detailed shards.
- API Reference - Details on external and internal APIs.
- Component View - Logical components and architectural patterns.
- Data Models - Core application entities and database schemas.
- Environment Variables Documentation - Placeholder for consolidated environment variable information.
- Infrastructure and Deployment Overview - Cloud providers, core services, and deployment strategy.
- Key Reference Documents - List of key documents referenced in the architecture.
- Operational Guidelines - Consolidated guidelines for error handling, coding standards, testing, and security.
- Project Structure - Monorepo organization and key directory descriptions.
- Sequence Diagrams - Core workflow and sequence diagrams.
- Technology Stack - Definitive technology selections for the project.
Frontend Specific Architecture Documents
- Frontend Architecture Document - The main frontend architecture document, linking to detailed shards.
- Frontend Project Structure - Detailed frontend directory structure and naming conventions.
- Frontend Style Guide - Styling approach, theme customization, and visual design specifications.
- Frontend Component Guide - Component naming, organization, and template for component specification.
- Frontend Coding Standards & Accessibility - Frontend-specific coding standards and accessibility (AX) implementation details.
- Frontend State Management - In-depth details of Zustand store structure, slices, selectors, and actions.
- Frontend API Interaction Layer - Client/service structure for API interactions and frontend error handling.
- Frontend Routing Strategy - Route definitions and protection mechanisms.
- Frontend Testing Strategy - Component, UI integration, and end-to-end testing strategies for the frontend.