docs: initial project architecture and specification

This commit is contained in:
2026-06-05 11:34:46 +00:00
commit d360856585
14 changed files with 1990 additions and 0 deletions
+96
View File
@@ -0,0 +1,96 @@
START HERE
This document is the entry point for all development work.
Before implementing any feature, modifying code, generating files, creating migrations, or refactoring existing functionality, read all project documentation.
---
Documentation Reading Order
1. 01-project-overview.md
2. 02-architecture.md
3. 03-database-design.md
4. 04-routing.md
5. 05-ui-pages.md
6. 06-admin-panel.md
7. 07-deployment.md
8. 08-roadmap.md
9. 09-coding-standards.md
10. 10-project-structure.md
11. 11-bootstrap-spec.md
---
Source of Truth
The documentation folder is the authoritative specification.
If code conflicts with documentation:
Documentation wins.
---
Project Goals
Build a:
- Personal Website
- Portfolio
- Technical Blog
- Contact Hub
Using:
- Go
- Fiber
- MariaDB
- Redis
- HTMX
- TinyMCE
---
Development Principles
- Keep implementation simple.
- Avoid over-engineering.
- Prefer maintainability.
- Prefer readability.
- Follow documented architecture.
- Follow documented routing.
- Follow documented database design.
---
Session Recovery
If implementation context is lost:
Stop.
Re-read all documentation files.
Continue implementation only after documentation review.
---
Important
Do not introduce:
- React
- Vue
- Angular
- Next.js
- Nuxt.js
- SPA Architecture
The project uses:
Server Side Rendering (SSR)
with:
Go Templates + HTMX