Welcome to the RSS-Remastered documentation. This guide helps you navigate all project documentation organized by purpose and phase.
| What You Need | Where to Go |
|---|---|
| Executive summary for stakeholders | Product Brief |
| Understand the product vision | Product Requirements (PRD) |
| Understand the system design | Architecture |
| Implement features | Project Context → Epics & Stories |
| Write tests | Test Design |
| Setup environment | Environment Setup |
| Track sprint progress | Sprint Artifacts |
Strategic and detailed documentation of what we're building and why.
-
analysis/product-brief-rss-remastered-2025-12-15.md - Product Brief
- Executive summary with clear value proposition
- Core vision (problem, solution, differentiators)
- Target users (Marcus, Sofia, Jordan personas)
- Success metrics and North Star vision
- Product scope (MVP definition, roadmap)
- Technology foundation and stack selection
- Risk mitigation strategies
- Strategic positioning and go-to-market
-
prd.md - Complete Product Requirements Document
- Executive summary and vision
- User stories and use cases
- 58 functional requirements across 9 categories
- 36 non-functional requirements
- Success metrics and release criteria
Product Brief is ideal for executive communication, stakeholder presentations, and community positioning. PRD is the detailed technical requirements reference.
Technical decisions, patterns, and system design.
-
architecture.md - Architecture Decision Document
- Technology stack decisions (FastAPI, React, SQLite)
- System architecture patterns (monolith-first approach)
- Data models and relationships
- Integration patterns (*arr stack, media servers)
- Deployment architecture (single container)
- Security and performance considerations
-
ux-design-specification.md - User Experience Specification
- Visual design system (Tailwind CSS 4.x + shadcn/ui)
- Responsive layout patterns
- User flows and wireframes
- Interaction patterns
- Accessibility requirements
Read these to understand how the system is designed.
Critical information for implementing features correctly.
- project_context.md - Project Context for AI Agents
- Technology stack versions
- Language and framework rules
- Testing requirements
- Code quality standards
- Critical implementation rules (45 rules total)
Reference this constantly during implementation to avoid common mistakes.
Comprehensive testing strategy and tools.
-
test-design-system.md - Test Design System
- Testing philosophy and strategy
- Test pyramid approach
- Framework choices (Pytest, Vitest, Playwright)
- Coverage requirements
- CI/CD integration
-
test-design-report.md - Test Design Report
- Detailed test scenarios
- Risk assessment
- Test environment configuration
- Readiness validation
-
test-environment-readiness.md - Test Environment Readiness Report
- Environment validation results
- Tool configuration verification
- Infrastructure readiness
Follow these to ensure comprehensive test coverage.
Sprint artifacts and development progress.
Active development stories with implementation details:
- sprint-artifacts/1-1-initialize-backend-project-structure.md - Backend scaffolding ✅
- sprint-artifacts/1-2-initialize-frontend-project-structure.md - Frontend scaffolding ✅
- sprint-artifacts/1-5-configure-pydantic-settings.md - Pydantic settings configuration ✅
- epics.md - Complete epic and story breakdown
- Epic 1: Core Infrastructure Setup (MVP Foundation)
- Epic 2: Subscription Management
- Epic 3: Content Aggregation Engine
- Epic 4-9: Additional epics with user stories
Check sprint-artifacts/ for active development tasks and implementation notes.
Planning and readiness validation.
-
implementation-readiness-report-2025-12-14.md - Implementation Readiness Report
- Requirements → Architecture → Stories validation
- Gap analysis and risk assessment
- Readiness score: 92/100 (READY TO IMPLEMENT)
- Recommendations for implementation
-
bmm-workflow-status.yaml - BMAD Method workflow status
- Current phase: Implementation (Phase 3)
- Completed workflows: PRD, UX Design, Architecture, Test Design
- Next steps: Sprint planning
Review these to understand project status and readiness.
Setup guides and configuration references.
- devcontainer-setup.md - Dev Container setup guide
- devcontainer-persistence-guide.md - Persistent storage patterns
- environment-setup-complete.md - Environment validation
- vscode-configuration-review.md - VS Code settings
- playwright-extension-guide.md - Playwright test tooling
Reference these for development environment setup.
Guides for development workflow tools.
- claude-hooks-reference.md - Claude Code hooks configuration
- bmad-subagent-quickstart.md - BMAD subagent quick reference
- bmad-subagent-orchestration.md - Advanced BMAD orchestration patterns
Use these to work effectively with AI-assisted development tools.
Background research, strategic documents, and brainstorming sessions.
-
analysis/product-brief-rss-remastered-2025-12-15.md - Product Brief
- Strategic positioning document
- Executive-level communication
- Community positioning (r/selfhosted posts)
- Contributor onboarding
-
analysis/brainstorming-session-2025-12-13.md - Initial brainstorming session
- Product vision exploration
- Feature ideation
- Technical approach discussions
Review these for context on product decisions and strategic positioning.
All documentation in this project follows:
- CommonMark specification (strict compliance)
- Task-oriented structure (what you can accomplish)
- Active voice, present tense
- Mermaid diagrams for visual explanations
- No time estimates (focus on steps, not duration)
See BMAD documentation standards for complete guidelines.
- Read analysis/product-brief-rss-remastered-2025-12-15.md - Get the strategic overview
- Read prd.md - Understand detailed requirements
- Read architecture.md - Understand how it's designed
- Review project_context.md - Learn critical implementation rules
- Check implementation-readiness-report-2025-12-14.md - See current status
- Find your story in epics.md or sprint-artifacts/
- Reference project_context.md for implementation rules
- Check architecture.md for relevant patterns
- Review test-design-system.md for testing approach
- Check environment-setup-complete.md for environment validation
- Review test-environment-readiness.md for test tool status
- Reference architecture.md for system design context
- Read test-design-system.md for strategy
- Check test-design-report.md for scenarios
- Reference project_context.md for testing rules (Rule 15-23)
When adding or updating documentation:
- Follow CommonMark strictly - Use ATX-style headers, fenced code blocks, consistent list markers
- No time estimates - Focus on steps and dependencies, not duration
- Task-oriented writing - Answer "how do I..." questions
- Include examples - Show concrete usage where helpful
- Link between docs - Use relative paths like
[architecture](architecture.md) - Update this README - Add new docs to the appropriate section
- Check the relevant section above
- Search within specific docs (all are CommonMark-formatted)
- Review analysis/product-brief-rss-remastered-2025-12-15.md for strategic context
- Review prd.md for detailed requirements
- Check architecture.md for design decisions
- Consult project_context.md for implementation rules