feat: reword phase to epic, update mkdocs

2025-11-05 09:28:33 +01:00
parent 65a428534c
commit ace9678f6c
64 changed files with 214 additions and 208 deletions
--- a/docs/content/stories/epic8/8.1-oidc-support.md
+++ b/docs/content/stories/epic8/8.1-oidc-support.md
@@ -0,0 +1,47 @@
+# Story 8.1: OpenID Connect (OIDC) Support
+
+## Metadata
+- **Story ID**: 8.1
+- **Title**: OpenID Connect (OIDC) Support
+- **Epic**: 8 - Advanced Features & Polish
+- **Status**: Pending
+- **Priority**: Low
+- **Estimated Time**: 6-8 hours
+- **Dependencies**: 2.1
+
+## Goal
+Add OpenID Connect (OIDC) support for external identity providers and OIDC provider capabilities.
+
+## Description
+This story implements OIDC client support for validating tokens from external IdPs and optional OIDC provider functionality.
+
+## Deliverables
+
+### 1. OIDC Client Support
+- Install `github.com/coreos/go-oidc`
+- Validate tokens from external IdP
+- Map claims to internal user
+- Integration with authentication system
+
+### 2. OIDC Provider (Optional)
+- Discovery endpoint
+- JWKS endpoint
+- Token endpoint
+- UserInfo endpoint
+
+### 3. Documentation
+- Document OIDC setup in `docs/auth.md`
+- Configuration examples
+- Integration guide
+
+## Acceptance Criteria
+- [ ] OIDC client validates external tokens
+- [ ] Claims are mapped to internal users
+- [ ] OIDC provider works (if implemented)
+- [ ] Documentation is complete
+
+## Files to Create/Modify
+- `internal/auth/oidc_client.go` - OIDC client
+- `internal/auth/oidc_provider.go` - OIDC provider (optional)
+- `docs/auth.md` - OIDC documentation
+
--- a/docs/content/stories/epic8/8.2-graphql-api.md
+++ b/docs/content/stories/epic8/8.2-graphql-api.md
@@ -0,0 +1,50 @@
+# Story 8.2: GraphQL API
+
+## Metadata
+- **Story ID**: 8.2
+- **Title**: GraphQL API
+- **Epic**: 8 - Advanced Features & Polish
+- **Status**: Pending
+- **Priority**: Low
+- **Estimated Time**: 8-10 hours
+- **Dependencies**: 1.5, 2.1, 4.1
+
+## Goal
+Add optional GraphQL API alongside REST API for flexible data querying.
+
+## Description
+This story implements a GraphQL API using gqlgen that provides an alternative to REST endpoints with flexible querying capabilities.
+
+## Deliverables
+
+### 1. GraphQL Schema
+- Install `github.com/99designs/gqlgen`
+- Create GraphQL schema:
+  - User queries
+  - Blog queries
+  - Mutations
+  - Subscriptions (optional)
+
+### 2. GraphQL Resolvers
+- Implement resolvers:
+  - Use existing services
+  - Add authorization checks
+  - Error handling
+
+### 3. GraphQL Endpoint
+- Add GraphQL endpoint: `POST /graphql`
+- GraphQL playground: `GET /graphql` (development)
+- Integration with authentication
+
+## Acceptance Criteria
+- [ ] GraphQL schema is defined
+- [ ] Resolvers work correctly
+- [ ] Authorization is enforced
+- [ ] GraphQL endpoint works
+- [ ] GraphQL playground works (dev)
+
+## Files to Create/Modify
+- `api/graphql/schema.graphql` - GraphQL schema
+- `internal/api/graphql/resolvers.go` - Resolvers
+- `internal/server/routes.go` - Add GraphQL route
+
--- a/docs/content/stories/epic8/8.3-additional-modules.md
+++ b/docs/content/stories/epic8/8.3-additional-modules.md
@@ -0,0 +1,42 @@
+# Story 8.3: Additional Sample Modules
+
+## Metadata
+- **Story ID**: 8.3
+- **Title**: Additional Sample Modules
+- **Epic**: 8 - Advanced Features & Polish
+- **Status**: Pending
+- **Priority**: Low
+- **Estimated Time**: 10-12 hours
+- **Dependencies**: 4.1
+
+## Goal
+Create additional sample modules to demonstrate different use cases and patterns.
+
+## Description
+This story creates additional sample modules (notification, analytics) to show different module patterns and use cases.
+
+## Deliverables
+
+### 1. Notification Module
+- Create `modules/notification/`:
+  - Email templates
+  - Notification preferences
+  - Notification history
+  - Notification API
+
+### 2. Analytics Module
+- Create `modules/analytics/`:
+  - Event tracking
+  - Analytics dashboard API
+  - Export functionality
+
+## Acceptance Criteria
+- [ ] Notification module works
+- [ ] Analytics module works
+- [ ] Modules demonstrate different patterns
+- [ ] Modules are well-documented
+
+## Files to Create/Modify
+- `modules/notification/` - Notification module
+- `modules/analytics/` - Analytics module
+
--- a/docs/content/stories/epic8/8.4-final-polish.md
+++ b/docs/content/stories/epic8/8.4-final-polish.md
@@ -0,0 +1,63 @@
+# Story 8.4: Final Polish and Optimization
+
+## Metadata
+- **Story ID**: 8.4
+- **Title**: Final Polish and Optimization
+- **Epic**: 8 - Advanced Features & Polish
+- **Status**: Pending
+- **Priority**: Medium
+- **Estimated Time**: 8-10 hours
+- **Dependencies**: All previous epics
+
+## Goal
+Final polish, bug fixes, performance optimization, and security audit.
+
+## Description
+This story covers final polish including code review, refactoring, bug fixes, performance profiling, security audit, and documentation review.
+
+## Deliverables
+
+### 1. Code Review and Refactoring
+- Code review of all modules
+- Refactor for consistency
+- Improve code quality
+- Remove dead code
+
+### 2. Bug Fixes
+- Fix identified bugs
+- Address technical debt
+- Improve error handling
+
+### 3. Performance Profiling
+- Profile critical paths
+- Optimize bottlenecks
+- Add database query caching
+- Optimize N+1 queries
+- Add response caching (Redis)
+- Implement connection pooling optimizations
+- Add database read replicas support
+
+### 4. Security Audit
+- Security review
+- Fix security issues
+- Update dependencies
+- Security best practices
+
+### 5. Documentation Review
+- Review all documentation
+- Update outdated docs
+- Add missing documentation
+- Improve examples
+
+## Acceptance Criteria
+- [ ] Code quality is high
+- [ ] Bugs are fixed
+- [ ] Performance is optimized
+- [ ] Security audit passes
+- [ ] Documentation is complete
+
+## Files to Create/Modify
+- All code files (refactoring)
+- Documentation files (review)
+- Performance optimizations
+
--- a/docs/content/stories/epic8/README.md
+++ b/docs/content/stories/epic8/README.md
@@ -0,0 +1,40 @@
+# Epic 8: Advanced Features & Polish
+
+## Overview
+Add advanced features (OIDC, GraphQL, API Gateway), performance optimization, additional sample modules, and final polish and bug fixes.
+
+## Stories
+
+### 8.1 OpenID Connect (OIDC) Support
+- [Story: 8.1 - OIDC Support](./8.1-oidc-support.md)
+- **Goal:** Add OpenID Connect (OIDC) support for external identity providers.
+- **Deliverables:** OIDC client, OIDC provider (optional), documentation
+
+### 8.2 GraphQL API
+- [Story: 8.2 - GraphQL API](./8.2-graphql-api.md)
+- **Goal:** Add optional GraphQL API alongside REST API.
+- **Deliverables:** GraphQL schema, resolvers, GraphQL endpoint
+
+### 8.3 Additional Sample Modules
+- [Story: 8.3 - Additional Modules](./8.3-additional-modules.md)
+- **Goal:** Create additional sample modules to demonstrate different use cases.
+- **Deliverables:** Notification module, Analytics module
+
+### 8.4 Final Polish and Optimization
+- [Story: 8.4 - Final Polish](./8.4-final-polish.md)
+- **Goal:** Final polish, bug fixes, performance optimization, and security audit.
+- **Deliverables:** Code review, bug fixes, performance optimization, security audit, documentation review
+
+## Deliverables Checklist
+- [ ] OIDC support (optional)
+- [ ] GraphQL API (optional)
+- [ ] Additional sample modules
+- [ ] Performance optimizations
+- [ ] Final polish
+
+## Acceptance Criteria
+- Advanced features work correctly
+- Performance is optimized
+- Code quality is high
+- Security audit passes
+- Documentation is complete