 tiennm99
|
a69fccbaf0
|
docs: sweep all docs + README for post-refactor state
Update root README + all 6 docs in ./docs/ to reflect the completed
monorepo refactor (server/ + client/, Java 25, gson, JUnit 5,
com.miti99.caro.{common,server}.*, caro-server 0.0.1-beta).
- README.md: quickstart commands, project structure, architecture
diagram; drop CLI + built-in web UI sections. Credits preserved
verbatim (Ratel/ainilili historical attribution).
- docs/codebase-summary.md: full rewrite — new directory tree,
package layout, build config, CI, version.
- docs/code-standards.md: package prefix (com.miti99.caro), Java 25
tools, modernization guidelines (records, var, switch expressions),
JUnit 5.
- docs/deployment-guide.md: full rewrite — Java 25 prereqs,
docker-compose path, standalone jar commands, nginx reverse proxy
updated, JUnit 5 test output, zero-downtime update flow.
- docs/project-overview-pdr.md: tech stack (Java 25 + gson + JUnit 5
+ shade), features matrix (no CLI/built-in UI), architecture
diagram, deps table, version history, quick start commands.
- docs/project-roadmap.md: add Phase 7 (2026-04-10 refactor) with
full change list; mark Phase 4 built-in UI as removed; update
version history with 0.0.1-beta; Decision 1 updated to Java 25.
- docs/system-architecture.md: full rewrite — Netty pipeline without
StaticFileHandler, new package layout, single-module dependency
graph, gson on WebSocket, Msg as record, deployment diagram with
docker-compose services, proto files staged for future use.
Grep verification: all remaining mentions of legacy names
(landlords-, org.nico.ratel, StaticFileHandler, I18nHelper, noson,
1.4.0) appear only in:
- the Phase 7 refactor description in project-roadmap.md
(intentional historical context)
- protoc-generated ClientTransferData.java / ServerTransferData.java
internal variable names and embedded descriptor byte strings
(public Java package is correct; preserving wire format)
|
2026-04-10 19:33:00 +07:00 |
|
|
tiennm99
|
ce101bd778
|
docs: add comprehensive project documentation
- project-overview-pdr.md: PDR, goals, features, tech stack
- system-architecture.md: diagrams, protocol, event codes, data flow
- codebase-summary.md: module breakdown, key classes, test structure
- code-standards.md: Java/JS conventions, JSDoc, Git rules
- deployment-guide.md: build, run, CI/CD, troubleshooting
- project-roadmap.md: completed phases, future ideas, decision log
|
2026-04-10 13:37:54 +07:00 |
|