Skip to content

docs: add docs/ folder with 8 markdown documentation files - #22

Merged
EdgarEldy merged 9 commits into
developfrom
feature/docs
Nov 9, 2026
Merged

EdgarEldy merged 9 commits into
developfrom
feature/docs

Conversation

@EdgarEldy

Copy link
Copy Markdown
Owner

Summary

Creates a docs/ folder with 8 pedagogical Markdown files covering the full project.

  • getting-started.md - Option A (full Docker Compose) and Option B (local Maven dev with docker run for PostgreSQL)
  • architecture.md - Layered architecture diagram, package structure, key design decisions (contract/impl, ApiResponse, records, ProblemDetail)
  • api-reference.md - All endpoints grouped by resource with request/response shapes and HTTP status codes
  • data-model.md - Full EER diagram (all tables V1-V12) and Flyway migration history
  • security.md - Complete auth flows (register/activate/login/refresh/logout/reset), JWT claims, authorization rules, token blacklist
  • configuration.md - Profile comparison, all environment variables, Spring properties explained with the "why"
  • testing.md - Test pyramid, Testcontainers vs H2 rationale, @WebMvcTest JwtAuthFilter pitfall, cache isolation, naming convention
  • deployment.md - Multi-stage Dockerfile walkthrough, docker-compose, GitHub Actions CI, production notes

Each file is written to be understandable by someone learning Spring Boot, with concept explanations alongside the technical details.

Test plan

  • All 8 files present in docs/
  • No broken relative links
  • Seed credentials correct: admin@example.com / Admin1234!

@EdgarEldy
EdgarEldy merged commit edd607b into develop Nov 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant