docs: ensure newline before lists across docs for MkDocs rendering
This commit is contained in:
@@ -5,6 +5,7 @@ Superseded by [ADR-0034: Go Version Upgrade to 1.25.3](./0034-go-version-upgrade
|
||||
|
||||
## Context
|
||||
Go releases new versions regularly with new features, performance improvements, and security fixes. We need to choose a Go version that:
|
||||
|
||||
- Provides necessary features for the platform
|
||||
- Has good ecosystem support
|
||||
- Is stable and production-ready
|
||||
|
||||
@@ -5,6 +5,7 @@ Accepted
|
||||
|
||||
## Context
|
||||
The platform follows a microservices architecture where each service has its own database connection. The ORM/library must:
|
||||
|
||||
- Support PostgreSQL (primary database)
|
||||
- Provide type-safe query building
|
||||
- Support code generation (reduces boilerplate)
|
||||
|
||||
@@ -10,6 +10,7 @@ The platform needs to scale independently, support team autonomy, and enable fle
|
||||
Design the platform as **microservices architecture from day one**:
|
||||
|
||||
1. **Core Services**: Core business services are separate microservices:
|
||||
|
||||
- **Auth Service** (`cmd/auth-service/`): JWT token generation/validation
|
||||
- **Identity Service** (`cmd/identity-service/`): User CRUD, password management
|
||||
- **Authz Service** (`cmd/authz-service/`): Permission resolution, authorization
|
||||
|
||||
@@ -66,6 +66,7 @@ All communication goes through service clients - no direct in-process calls even
|
||||
|
||||
## Development Mode
|
||||
For local development, services run in the same repository but as separate processes:
|
||||
|
||||
- Each service has its own entry point (`cmd/{service}/`)
|
||||
- Services communicate via service clients (gRPC or HTTP) - no direct in-process calls
|
||||
- Docker Compose orchestrates all services
|
||||
|
||||
@@ -10,6 +10,7 @@ The platform follows a microservices architecture where each service (Auth, Iden
|
||||
- **Option 2**: Separate repositories (each service in its own repository)
|
||||
|
||||
The decision affects:
|
||||
|
||||
- Code sharing and dependencies
|
||||
- Development workflow
|
||||
- CI/CD complexity
|
||||
|
||||
@@ -5,6 +5,7 @@ Accepted
|
||||
|
||||
## Context
|
||||
The platform follows a microservices architecture where each service is independently deployable. We need a central entry point that handles:
|
||||
|
||||
- Request routing to backend services
|
||||
- Authentication and authorization at the edge
|
||||
- Rate limiting and throttling
|
||||
|
||||
@@ -5,6 +5,7 @@ Accepted
|
||||
|
||||
## Context
|
||||
The platform follows a microservices architecture where services need to discover and communicate with each other. We need a service discovery mechanism that:
|
||||
|
||||
- Enables services to find each other dynamically
|
||||
- Supports health checking and automatic deregistration
|
||||
- Works in both development (Docker Compose) and production (Kubernetes) environments
|
||||
|
||||
@@ -5,6 +5,7 @@ Accepted
|
||||
|
||||
## Context
|
||||
ADR-0002 established Go 1.24.3 as the minimum required version. Since then:
|
||||
|
||||
- Go 1.25.3 has been released with new features, performance improvements, and security fixes
|
||||
- The project requires access to newer language features and tooling improvements
|
||||
- Dependencies may benefit from Go 1.25.3 optimizations
|
||||
|
||||
@@ -5,6 +5,7 @@ This directory contains Architecture Decision Records (ADRs) for the Go Platform
|
||||
## What are ADRs?
|
||||
|
||||
ADRs document important architectural decisions made during the project. They help:
|
||||
|
||||
- Track why decisions were made
|
||||
- Understand the context and constraints
|
||||
- Review decisions when requirements change
|
||||
@@ -13,6 +14,7 @@ ADRs document important architectural decisions made during the project. They he
|
||||
## ADR Format
|
||||
|
||||
Each ADR follows this structure:
|
||||
|
||||
- **Status**: Proposed | Accepted | Rejected | Superseded
|
||||
- **Context**: The situation that led to the decision
|
||||
- **Decision**: What was decided
|
||||
|
||||
Reference in New Issue
Block a user