Docs: add project documentation foundation and architecture docs#320
Docs: add project documentation foundation and architecture docs#320
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 18eb728b38
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ## 검증 | ||
|
|
||
| - [WordAiService.java](/Users/solfe/Desktop/WORK/llv/llv-api/src/main/java/com/linglevel/api/word/service/WordAiService.java) 에서 homograph, variant, 품사 예외 케이스를 포함한 구조화 프롬프트와 토큰 비용 로깅을 확인한다. |
There was a problem hiding this comment.
Replace workstation-specific links with repo-relative paths
The verification section is linking to an absolute local path (/Users/solfe/...) that only exists on the original author’s machine. In GitHub and in other developer clones this link is dead, so readers cannot open the referenced code and the decision record loses traceability. The same pattern appears across multiple new decision docs, so these links should be rewritten to repository-relative paths.
Useful? React with 👍 / 👎.
Summary
Problem
The repository had little navigable documentation for structure, architectural context, and major engineering decisions.
Solution
Create a lightweight documentation hub, record key technical decisions in a blog-style format, and add architecture documents for the overall system plus three core domains.
Changes
Related Issues