Skip to content

Commit 99fda33

Browse files
wkdgus1164claude
andcommitted
docs: CLAUDE.md에 문서 작성/배포 가이드 추가
문서 구조, 말투 규칙, 빌드/미리보기/배포 명령어, 네비게이션 수정 방법을 에이전트가 참고할 수 있도록 문서화. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a9de2be commit 99fda33

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,61 @@ See `docs/adding-formats.md`. Create a parser/writer class matching the Protocol
8282

8383
Core: `olefile` (BSD). Optional: `langchain-text-splitters`+`langchain-core` (chunking), `pymupdf` (PDF), `pillow`+`pytesseract` (OCR). Dev: `pytest`, `pytest-cov`, `mypy`, `ruff`.
8484

85+
## Documentation
86+
87+
### Structure
88+
89+
```
90+
docs/
91+
├── index.md # 홈 — 퀵스타트, 주요 기능
92+
├── getting-started.md # 설치, CLI, Python API 사용법
93+
├── architecture.md # 파이프라인, 모듈 의존성, Mermaid 다이어그램
94+
├── adding-formats.md # 새 Parser/Writer 추가 가이드 (기여자용)
95+
└── api/
96+
├── index.md # API 개요 + 최상위 API (mkdocstrings 자동 생성)
97+
├── models.md # Document 모델 (mkdocstrings 자동 생성)
98+
├── parsers.md # HWP/HWPX 파서 (mkdocstrings 자동 생성)
99+
├── writers.md # Markdown Writer (mkdocstrings 자동 생성)
100+
└── registry.md # FormatRegistry + Protocol (mkdocstrings 자동 생성)
101+
```
102+
103+
### Writing style
104+
105+
- 말투: es-toolkit 스타일 친근한 존댓말 (`~예요`, `~해요`, `~돼요`)
106+
- 관점: **외부 프로젝트에 설치해서 쓰는 사용자** 기준. 내부 소스코드를 복붙하지 않는다.
107+
- CLI 예제는 반드시 `uv run ureca_document_parser ...` 형태로 작성한다.
108+
- 예제 파일명은 실제 사용 시나리오 기반 (예: `보고서.hwp`, `제안서.hwpx`)
109+
- `docs/api/` 하위 파일은 `mkdocstrings`가 docstring에서 자동 생성하므로 설명문만 작성한다.
110+
- `docs/adding-formats.md`만 기여자(contributor) 관점으로 작성한다.
111+
- Mermaid 다이어그램 사용 가능 (mkdocs.yml에 설정 완료)
112+
- MkDocs admonition 사용 가능: `!!! note`, `!!! info`, `!!! warning`
113+
114+
### Build & preview
115+
116+
```bash
117+
uv sync --extra docs # 문서 의존성 설치
118+
uv run mkdocs serve # http://127.0.0.1:8000 로컬 미리보기
119+
uv run mkdocs build # site/ 디렉토리에 정적 파일 빌드
120+
```
121+
122+
### Deploy
123+
124+
배포는 자동이다. `main` 브랜치에 push하면 `.github/workflows/docs.yml`이 실행되어 GitHub Pages에 배포된다.
125+
126+
- 워크플로우: `mkdocs gh-deploy --force``gh-pages` 브랜치에 push
127+
- Pages 설정: Source = `gh-pages` branch (GitHub Settings → Pages)
128+
- URL: https://ureca-corp.github.io/document_parser/
129+
130+
수동 배포가 필요한 경우:
131+
132+
```bash
133+
uv run mkdocs gh-deploy --force
134+
```
135+
136+
### Navigation
137+
138+
페이지를 추가/삭제하면 `mkdocs.yml``nav:` 섹션을 함께 수정해야 한다.
139+
85140
## CI
86141

87142
GitHub Actions (`.github/workflows/ci.yml`) runs on push/PR to main: tests on Python 3.12 + 3.13, plus ruff lint/format checks.

0 commit comments

Comments
 (0)