Skip to content

공개 README와 아키텍처 안내를 구성한다 - #38

Merged
opficdev merged 4 commits into
developfrom
docs/#35
Sep 5, 2026
Merged

opficdev merged 4 commits into
developfrom
docs/#35

Conversation

@opficdev

@opficdev opficdev commented Sep 5, 2026

Copy link
Copy Markdown
Owner

🔗 연관된 이슈

🎯 작업 목적

첫 방문자가 Cradle의 설치와 첫 graph 구성을 빠르게 파악하고, 필요에 따라 API 안내와 package target 구조로 이동할 수 있는 공개 문서 진입점 구성

📝 작업 내용

📌 요약

  • README.md의 소개·설치·첫 graph·문서 탐색 흐름 재구성
  • SwiftPM from: "1.0.0" 기반 공개 release 설치 경로 구성
  • docs/Architecture.md의 package target·Macro·Mermaid artifact 경계 추가
  • Mermaid edge label의 parser 오류 수정과 Mermaid 11.17.2 구문 분석 확인

🔍 상세

  • README.md

    • 중앙 정렬 소개와 ExampleApp·DocC·아키텍처·테스트·License 탐색 경로 구성
    • Cradle product 설치를 첫 graph 앞에 배치
    • 타입 기반 Factory 연결, .shared, .transient, @External의 첫 사용 예제 추가
    • CradleTesting의 .mock 편의 API와 Cradle의 .replace 경계 구분
    • CradlePlugin, Xcode Mermaid 복사, Deploy SPM 절차를 접이식 구역으로 분리
  • docs/Architecture.md

    • 소비자 target의 Cradle, CradleTesting, CradlePlugin 연결 경로 표시
    • CradleMacros의 Macro 확장·compiler diagnostic 경로와 Mermaid 생성 경로 분리
    • CradleDiagramMaker artifact 제작 target과 소비자 build 경계 표시
    • .mmd를 개발용 산출물로 한정하고 app·library binary 미포함 명시

✅ 검증

  • swift build — 종료 코드 0
  • swift test — 종료 코드 0
  • git diff --check origin/develop...HEAD — 종료 코드 0
  • README·Architecture 상대 링크, code fence, details 태그 정적 검사 통과
  • Mermaid 11.17.2 mermaid.parse로 소비자·artifact 다이어그램 구문 분석 통과
  • 실제 원격 1.0.0 소비자 설치, Mermaid 시각 렌더링, app·Simulator 실행 미수행

🔄 변경 흐름

flowchart LR
    README["README"] --> Install["SwiftPM 설치"]
    Install --> Release["from: 1.0.0"]
    README --> FirstGraph["첫 graph"]
    README --> Docs["문서 탐색"]
    Docs --> Architecture["docs/Architecture.md"]
    Docs --> DocC["DependencyGraph · CradleTesting DocC"]
    README -. 제거된 develop branch 설치 안내 .-> Develop["branch: develop"]
Loading

@opficdev opficdev self-assigned this Sep 5, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 5, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-05T15:26:18.764667Z 98f7d14 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

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

Copy link
Copy Markdown

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: 98f7d14cb3

ℹ️ 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".

Comment thread README.md
Comment thread README.md
@opficdev
opficdev merged commit d927a22 into develop Sep 5, 2026
5 checks passed
@opficdev
opficdev deleted the docs/#35 branch September 5, 2026 15:56
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.

공개 README와 아키텍처 안내를 구성한다

1 participant