docs: ensure newline before lists across docs for MkDocs rendering
This commit is contained in:
@@ -85,6 +85,7 @@ Tasks are organized by epic and section. Each task file follows the naming conve
|
||||
## Task Status Tracking
|
||||
|
||||
To track task completion:
|
||||
|
||||
1. Update the Status field in each task file
|
||||
2. Update checkboxes in the main plan.md
|
||||
3. Reference task IDs in commit messages: `[0.1.1] Initialize Go module`
|
||||
|
||||
@@ -36,6 +36,7 @@ Tasks are organized by epic, with each major task section having its own detaile
|
||||
## Task Status
|
||||
|
||||
Each task file includes:
|
||||
|
||||
- **Task ID**: Unique identifier (e.g., `0.1.1`)
|
||||
- **Title**: Descriptive task name
|
||||
- **Epic**: Implementation epic
|
||||
@@ -50,6 +51,7 @@ Each task file includes:
|
||||
## Task Tracking
|
||||
|
||||
Tasks can be tracked using:
|
||||
|
||||
- GitHub Issues (linked from tasks)
|
||||
- Project boards
|
||||
- Task management tools
|
||||
|
||||
@@ -19,6 +19,7 @@ This story implements a complete logging system using Zap that provides structur
|
||||
|
||||
### 1. Logger Interface (`pkg/logger/logger.go`)
|
||||
Define `Logger` interface with:
|
||||
|
||||
- `Debug(msg string, fields ...Field)` - Debug level logging
|
||||
- `Info(msg string, fields ...Field)` - Info level logging
|
||||
- `Warn(msg string, fields ...Field)` - Warning level logging
|
||||
@@ -30,6 +31,7 @@ Define `Logger` interface with:
|
||||
|
||||
### 2. Zap Implementation (`internal/logger/zap_logger.go`)
|
||||
Implement `Logger` interface using Zap:
|
||||
|
||||
- Structured JSON logging for production mode
|
||||
- Human-readable console logging for development mode
|
||||
- Configurable log levels (debug, info, warn, error)
|
||||
@@ -40,6 +42,7 @@ Implement `Logger` interface using Zap:
|
||||
|
||||
### 3. Request ID Middleware (`internal/logger/middleware.go`)
|
||||
Gin middleware for request correlation:
|
||||
|
||||
- Generate unique request ID per HTTP request
|
||||
- Add request ID to request context
|
||||
- Add request ID to all logs within request context
|
||||
|
||||
@@ -19,6 +19,7 @@ This story sets up the complete CI/CD pipeline using GitHub Actions and provides
|
||||
|
||||
### 1. GitHub Actions Workflow (`.github/workflows/ci.yml`)
|
||||
Complete CI pipeline with:
|
||||
|
||||
- Go 1.24 setup
|
||||
- Go module caching for faster builds
|
||||
- Linting with golangci-lint or staticcheck
|
||||
@@ -30,6 +31,7 @@ Complete CI pipeline with:
|
||||
|
||||
### 2. Comprehensive Makefile
|
||||
Developer-friendly Makefile with commands:
|
||||
|
||||
- `make test` - Run all tests
|
||||
- `make test-coverage` - Run tests with coverage report
|
||||
- `make lint` - Run linters
|
||||
|
||||
@@ -19,6 +19,7 @@ This story implements the dependency injection system using Uber FX and creates
|
||||
|
||||
### 1. DI Container (`internal/di/container.go`)
|
||||
FX-based dependency injection container:
|
||||
|
||||
- Initialize FX container
|
||||
- Register Config and Logger providers
|
||||
- Basic lifecycle hooks (OnStart, OnStop)
|
||||
@@ -27,12 +28,14 @@ FX-based dependency injection container:
|
||||
|
||||
### 2. DI Providers (`internal/di/providers.go`)
|
||||
Provider functions for core services:
|
||||
|
||||
- `ProvideConfig() fx.Option` - Configuration provider
|
||||
- `ProvideLogger() fx.Option` - Logger provider
|
||||
- Provider functions return FX options for easy composition
|
||||
|
||||
### 3. Application Entry Point (`cmd/platform/main.go`)
|
||||
Main application bootstrap:
|
||||
|
||||
- Load configuration
|
||||
- Initialize DI container with core services
|
||||
- Set up basic application lifecycle
|
||||
|
||||
@@ -28,6 +28,7 @@ This story extends the basic DI container to support core kernel services only:
|
||||
|
||||
### 2. Provider Functions (`internal/di/providers.go`)
|
||||
Complete provider functions for core kernel services only:
|
||||
|
||||
- `ProvideConfig() fx.Option` - Configuration provider
|
||||
- `ProvideLogger() fx.Option` - Logger provider
|
||||
- `ProvideHealthCheckers() fx.Option` - Health check registry provider
|
||||
|
||||
@@ -114,6 +114,7 @@ go run cmd/platform/main.go
|
||||
- `config/default.yaml` - Add database config with schema isolation settings
|
||||
|
||||
**Note:** Entity schemas are created in Epic 2:
|
||||
|
||||
- `services/identity/ent/schema/user.go` - User entity (Identity Service)
|
||||
- `services/authz/ent/schema/role.go` - Role entity (Authz Service)
|
||||
- `services/authz/ent/schema/permission.go` - Permission entity (Authz Service)
|
||||
|
||||
@@ -19,6 +19,7 @@ This story defines service client interfaces for all core services (Auth, Identi
|
||||
|
||||
### 1. Service Client Interfaces (`pkg/services/`)
|
||||
Define interfaces for all core services:
|
||||
|
||||
- `AuthServiceClient` in `pkg/services/auth.go`:
|
||||
- `Login(ctx, email, password) (*TokenResponse, error)`
|
||||
- `RefreshToken(ctx, refreshToken) (*TokenResponse, error)`
|
||||
|
||||
@@ -19,6 +19,7 @@ This story extends the Authz Service (implemented in Story 2.3) with role manage
|
||||
|
||||
### 1. gRPC Service Extensions (`api/proto/authz.proto`)
|
||||
Extend Authz Service proto with role management RPCs:
|
||||
|
||||
- `CreateRoleRequest` / `CreateRoleResponse` - Create new role
|
||||
- `GetRoleRequest` / `GetRoleResponse` - Get role details
|
||||
- `ListRolesRequest` / `ListRolesResponse` - List all roles (with pagination)
|
||||
|
||||
@@ -19,6 +19,7 @@ This story implements the foundation for microservices architecture by creating
|
||||
|
||||
### 1. Service Client Interfaces (`pkg/services/`)
|
||||
Define service client interfaces for all core services:
|
||||
|
||||
- `IdentityServiceClient` - User and identity operations
|
||||
- `AuthServiceClient` - Authentication operations
|
||||
- `AuthzServiceClient` - Authorization operations
|
||||
@@ -29,6 +30,7 @@ Define service client interfaces for all core services:
|
||||
|
||||
### 2. Service Client Factory (`internal/services/factory.go`)
|
||||
Factory pattern for creating service clients:
|
||||
|
||||
- Create gRPC clients (primary)
|
||||
- Create HTTP clients (fallback)
|
||||
- Support service registry integration
|
||||
|
||||
Reference in New Issue
Block a user