Skip to content

Docs: add project documentation foundation and architecture docs#320

Merged
SolfE merged 5 commits intodevelopfrom
refactor/project-documentation
Mar 26, 2026
Merged

Docs: add project documentation foundation and architecture docs#320
SolfE merged 5 commits intodevelopfrom
refactor/project-documentation

Conversation

@SolfE
Copy link
Copy Markdown
Member

@SolfE SolfE commented Mar 26, 2026

Summary

  • add docs hub and documentation entrypoints
  • add engineering decision records for major technical choices
  • add architecture overview and core domain documents

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

  • docs hub and templates
  • decision records 001-009
  • architecture overview, streak, word, and book domain docs

Related Issues

  • None

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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, 품사 예외 케이스를 포함한 구조화 프롬프트와 토큰 비용 로깅을 확인한다.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@SolfE SolfE merged commit b5fda2a into develop Mar 26, 2026
1 check failed
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