Skip to content

Commit cc6f914

Browse files
committed
Refactor documentation for consistency and clarity
- Updated formatting in ARCHITECTURE.md and PROJECT_STRUCTURE.md to use consistent punctuation in lists. - Improved readability by replacing periods with dashes in item descriptions across both documents.
1 parent 90c10aa commit cc6f914

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

ARCHITECTURE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This service uses a modular **Layered Architecture** inspired by the [NestJS phi
66

77
We separate the system into 3 main layers:
88

9-
1. **Controller** Talks to the client
10-
2. **Service** Handles the business logic
11-
3. **Repository** Interacts with the database
9+
1. **Controller** - Talks to the client
10+
2. **Service** - Handles the business logic
11+
3. **Repository** - Interacts with the database
1212

1313
Each domain feature (e.g. `articles`, `profiles`, `tags`) is isolated into its own module, containing these layers plus:
1414

PROJECT_STRUCTURE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,21 +97,21 @@ shared/
9797

9898
### DTO Naming
9999

100-
- `CreateThingDto` used for `POST` requests
101-
- `UpdateThingDto` used for `PATCH`/`PUT` requests
102-
- `ThingResponseDto` or `ThingsResponseDto` response structure (singular or plural, depending on the request)
100+
- `CreateThingDto` - used for `POST` requests
101+
- `UpdateThingDto` - used for `PATCH`/`PUT` requests
102+
- `ThingResponseDto` or `ThingsResponseDto` - response structure (singular or plural, depending on the request)
103103
- Each DTO is defined via TypeBox and typed via `Static<typeof schema>`
104104
- DTO files live in `dto/` and share name with their schema
105105

106106
### Interface Naming
107107

108-
- `IThing` the core domain interface used in services
109-
- `ThingRow` the shape returned by Drizzle ORM (via InferSelectModel)
108+
- `IThing` - the core domain interface used in services
109+
- `ThingRow` - the shape returned by Drizzle ORM (via InferSelectModel)
110110
- Stored in `interfaces/` and always one interface per file
111111

112112
### Schema Naming
113113

114-
- `feature.schema.ts` contains Drizzle `pgTable()` definitions
114+
- `feature.schema.ts` - contains Drizzle `pgTable()` definitions
115115
- May also define `relations()` in the same file unless very large
116116
- If split, name the second file `feature-relations.schema.ts`
117117

0 commit comments

Comments
 (0)