docs: Add Korean Web Manual and GitHub Pages Deployment

[seonghobae]

Summary

NewsDOM API 프로젝트를 위한 매우 구체적인 실무형 한국어 웹 매뉴얼을 작성하고, GitHub Pages 배포 자동화를 구성했습니다.

Changes

• MkDocs 구성: mkdocs.yml (Material 테마 기반) 추가
• GitHub Actions: .github/workflows/gh-pages.yml 워크플로우 추가 (문서 자동 빌드 및 배포)
• 한국어 웹 매뉴얼 작성 (manual/):
  • index.md: 내부 파이프라인 흐름 및 아키텍처 개요
  • installation.md: 커스텀 실행 경로 설정 및 필수 하드웨어/테스트 요구사항
  • api-reference.md: JSON DOM 스키마 명세 및 Python requests 호출 실전 예제
  • development.md: 합성(Synthetic) 데이터 사용 원칙, 프라이빗 베이스라인 추출 스크립트, 수동 Git Flow 브랜치 전략

[github-advanced-security]

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

• The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
• Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
• You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

[seonghobae]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 01aebb38-1d5b-4e73-911c-af0b9e165f1c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

GitHub Pages 자동 배포 워크플로우, MkDocs 설정, 그리고 설치, 개발, API 참고 문서를 포함한 종합 문서 사이트 구성을 추가합니다. 이는 NewsDOM API의 로컬 설치, 사용법, 개발 기여 방식을 체계적으로 설명하는 공식 매뉴얼 기반 구조를 확립합니다.

Changes

Cohort / File(s)	Summary
GitHub Pages 자동 배포 .github/workflows/gh-pages.yml	main, master, develop 브랜치의 manual/** 경로 변경 시 자동으로 MkDocs 사이트를 빌드하여 GitHub Pages에 배포하는 워크플로우를 추가합니다.
MkDocs 설정 mkdocs.yml	문서 소스 디렉토리를 manual로 설정하고, Material 테마, 한국어 UI, 색상 팔레트를 구성한 MkDocs 설정 파일을 추가합니다. 4개 페이지 네비게이션을 정의합니다.
API 및 설치 가이드 manual/api-reference.md, manual/installation.md	FastAPI /parse 엔드포인트 사용법, Swagger/cURL/Python 예제, /health 엔드포인트 명세를 담은 API 참고 문서와 Python 환경 설정, 가상 환경 구성, 의존성 설치, MinerU 백엔드 구성 방법을 담은 설치 가이드를 추가합니다.
개발 및 아키텍처 문서 manual/index.md, manual/development.md	NewsDOM API의 처리 파이프라인(PDF 업로드 → MinerU CLI 실행 → JSON 구조 변환 → DOM 반환)을 설명하는 개요 문서와, 테스트 픽스처 규칙, Git Flow 브랜치 전략, 저장소 폴더 구조를 정의하는 개발 가이드를 추가합니다.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

📚 새로운 문서 페이지들이 펄럭이며,
깃허브의 흐름을 따라 자동 배포되고,
파이썬 환경부터 API까지 설명하는
친절한 설치 가이드와 함께,
NewsDOM의 비밀을 풀어내리라! 🐰✨

---

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name	Status	Explanation	Resolution
Description check	❌ Error	설명이 구체적인 변경사항을 나열했으나, 저장소의 요구 템플릿과 비교하면 필수 섹션이 불완전합니다.	Git Flow 대상 브랜치 명시, 검증 체크리스트(pytest 실행 여부) 확인, 필요한 후속 작업 설명을 추가하세요.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	제목이 변경의 핵심을 명확히 전달합니다. 한국어 웹 매뉴얼 추가와 GitHub Pages 배포 자동화라는 주요 변경사항을 간결하게 요약했습니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch develop

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 4

🧹 Nitpick comments (1)

manual/api-reference.md (1)

46-67: 섹션 제목과 예제 구현을 맞추면 더 명확합니다.

제목은 httpx 또는 requests인데 본문 예제는 requests만 있습니다. 제목을 requests 예제로 좁히거나 httpx 예제를 추가하는 편이 좋습니다.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@manual/api-reference.md` around lines 46 - 67, The section header "####
Python 클라이언트 예제 (`httpx` 또는 `requests`)" mismatches the body which only shows a
requests example; either change the header to "#### Python 클라이언트 예제 (requests)"
or add an equivalent httpx snippet; update the header text and/or insert a short
httpx POST example (using httpx.post with files opened in binary mode) so the
header and the example content in manual/api-reference.md are consistent.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@manual/api-reference.md`:
- Around line 75-125: The example JSON in the API reference contains non-JSON
placeholders like "{ ... }" (inside the "images" -> "bbox" and "captions" ->
"bbox" fields) which makes it invalid; update the "pages" example to be either
valid JSON by replacing placeholders with concrete numeric bbox objects (e.g.,
full "bbox": {"x0":..., "y0":..., "x1":..., "y1":...}) for the "images",
"captions", and any other "{ ... }" occurrences, or change the code fence
language to "jsonc" and add a short comment near those placeholders clarifying
they are illustrative; ensure keys referenced in the document such as
"document_id", "pages", "articles", "images", "bbox", and "quality" remain
unchanged so examples still map to the API fields.

In `@manual/development.md`:
- Line 70: Fix the typo in the documentation line referencing dom_builder.py by
changing the phrase "트기 구조" to "트리 구조" so the sentence reads that dom_builder.py
reconstructs MinerU's linear OCR data into a tree-structured DOM; locate the
string containing `dom_builder.py` and update the Korean phrase accordingly.

In `@manual/installation.md`:
- Around line 34-35: Update the examples in manual/installation.md to quote
package extras to avoid shell globbing: replace occurrences like pip install -e
.[dev] and pip install -e .[parser] with quoted forms such as pip install -e
".[dev]" and pip install -e ".[parser]" (apply the change for both the block at
lines ~34-35 and the one at ~45-46) so zsh/bash won’t expand the bracketed
extras.
- Line 7: The Python version requirement text "**Python**: `>=3.10, <3.14` 필수
(`python3.10` 강력 권장)" is inconsistent with the example that pins `python3.10`;
change the wording to clearly separate the allowed range and the recommended
version (e.g., "Required: Python >=3.10, <3.14. Recommended: Python 3.10") and
update any installation/example commands or notes that currently force
`python3.10` to instead state "recommended" or show how to install any
compatible version; apply the same change to the other occurrences referenced
(lines 21–23) so the messaging is consistent across the file.

---

Nitpick comments:
In `@manual/api-reference.md`:
- Around line 46-67: The section header "#### Python 클라이언트 예제 (`httpx` 또는
`requests`)" mismatches the body which only shows a requests example; either
change the header to "#### Python 클라이언트 예제 (requests)" or add an equivalent
httpx snippet; update the header text and/or insert a short httpx POST example
(using httpx.post with files opened in binary mode) so the header and the
example content in manual/api-reference.md are consistent.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2abe5926-64ee-43de-939b-804d74132c51

📥 Commits

Reviewing files that changed from the base of the PR and between 9baf69b and c24751c.

📒 Files selected for processing (6)

• .github/workflows/gh-pages.yml
• manual/api-reference.md
• manual/development.md
• manual/index.md
• manual/installation.md
• mkdocs.yml

[seonghobae]

CodeRabbit's documentation findings on this PR have been applied on feature/quality-gate so they will flow into develop when PR #2 merges. This keeps the fixes in the protected-branch merge path that is already waiting for external approval.

[seonghobae]

The PR #13 documentation feedback is now staged in PR #2's feature/quality-gate branch and will flow into develop when #2 merges.

[seonghobae]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[seonghobae]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[seonghobae]

@coderabbitai resolve

[coderabbitai]

✅ Actions performed

Comments resolved. Approval is disabled; enable reviews.request_changes_workflow to allow explicit top-level @coderabbitai resolve or @coderabbitai approve commands.

[seonghobae]

@coderabbitai review

A non-author approving review is requested for the current develop-to-main stack state.

[coderabbitai]

@seonghobae Sure! Triggering a full review of the current state of PR #13 now.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[seonghobae]

@coderabbitai approve

[seonghobae]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

✅ Actions performed

Comments resolved. Approval is disabled; enable reviews.request_changes_workflow to allow explicit top-level @coderabbitai resolve or @coderabbitai approve commands.