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