Skip to content

Commit 2d24cc7

Browse files
nbhansenclaude
andcommitted
Fix markdown lint errors in architecture.md
- Change section headers from h1 to h2 (MD025) - Remove trailing punctuation from headers (MD026) - Add blank lines around lists and code blocks (MD031, MD032) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 20fcfd8 commit 2d24cc7

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/Development/architecture.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ graph TB
3636
3737
---
3838

39-
# Foodplanner
39+
## Foodplanner
4040

4141
Meal planning app for institutions. Uses **separate repositories** for frontend and backend.
4242

@@ -92,7 +92,7 @@ sequenceDiagram
9292
Flutter-->>User: Shows success
9393
```
9494

95-
## Where Do I Look?
95+
## Where Do I Look
9696

9797
| I want to... | Look in... |
9898
|--------------|------------|
@@ -104,12 +104,14 @@ sequenceDiagram
104104

105105
## Tech Stack
106106

107-
**Frontend**
107+
**Frontend:**
108+
108109
- Flutter / Dart
109110
- GoRouter (navigation)
110111
- OpenAPI Generator (auto-generates API client)
111112

112-
**Backend**
113+
**Backend:**
114+
113115
- .NET / ASP.NET Core / C#
114116
- Entity Framework Core (code-first migrations)
115117
- PostgreSQL
@@ -133,7 +135,7 @@ The Flutter app doesn't manually write API calls:
133135

134136
---
135137

136-
# VTA (Visual Tangible Artefacts)
138+
## VTA (Visual Tangible Artefacts)
137139

138140
Visual/physical schedule tools. Uses a **monorepo** with frontend and backend in the same repository.
139141

@@ -182,7 +184,7 @@ sequenceDiagram
182184
Flutter-->>User: Shows confirmation
183185
```
184186

185-
## Where Do I Look?
187+
## Where Do I Look
186188

187189
| I want to... | Look in... |
188190
|--------------|------------|
@@ -193,10 +195,12 @@ sequenceDiagram
193195

194196
## Tech Stack
195197

196-
**Frontend**
198+
**Frontend:**
199+
197200
- Flutter / Dart
198201

199-
**Backend**
202+
**Backend:**
203+
200204
- .NET / ASP.NET Core / C#
201205
- Entity Framework Core (DB-first with scaffold)
202206
- MySQL
@@ -210,10 +214,12 @@ VTA uses **DB-first** - the database schema is the source of truth:
210214

211215
1. Design/modify tables directly in MySQL
212216
2. Scaffold models from the database:
217+
213218
```bash
214219
dotnet ef dbcontext scaffold "server=...;database=VTA" \
215220
Pomelo.EntityFrameworkCore.MySql -o scaffold -f
216221
```
222+
217223
3. This regenerates C# model classes to match the schema
218224

219225
### CI/CD Pipeline
@@ -231,7 +237,7 @@ VTA has automated CI/CD via GitHub Actions:
231237

232238
---
233239

234-
# Shared Resources
240+
## Shared Resources
235241

236242
| Repository | Description | Default Branch |
237243
|------------|-------------|----------------|

0 commit comments

Comments
 (0)