Skip to content

docs: align public setup guidance with uv defaults - #44

Merged
seonghobae merged 1 commit into
chore/security-manual-hardeningfrom
chore/uv-first-public-setup
Apr 10, 2026
Merged

docs: align public setup guidance with uv defaults#44
seonghobae merged 1 commit into
chore/security-manual-hardeningfrom
chore/uv-first-public-setup

Conversation

@seonghobae

@seonghobae seonghobae commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • align README.md, CONTRIBUTING.md, manual/installation.md, and manual/api-reference.md with the repository's uv-first install/run/test defaults
  • replace stale pip/venv quickstart snippets with uv sync, uv pip install, and uv run commands, including the local /health smoke path and Windows interpreter note
  • lock the drift down with regression coverage for public docs truth alignment

Verification

  • uv run pytest
  • uv run pytest --cov=src/newsdom_api --cov-branch --cov-report=term-missing --cov-fail-under=100
  • uv run mkdocs build --strict
  • local smoke: uv run uvicorn --app-dir src newsdom_api.main:app --host 127.0.0.1 --port 18000 + curl -fsS http://127.0.0.1:18000/health

Summary by CodeRabbit

설명서

  • 애플리케이션 설치 및 개발 환경 구축 절차 간소화
  • Windows와 Unix 계열 운영체제 모두에 대한 경로 안내 추가
  • API 서버 실행 및 헬스 체크 명령어 명시

테스트

  • 새로운 설정 절차 검증 테스트 추가
  • 레거시 설치 방법 제거 확인 테스트 추가

@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown
📝 Walkthrough

요약

이 풀 요청은 프로젝트 전반의 개발 환경 설정을 pip 및 수동 virtualenv 관리에서 uv 기반 환경 관리로 마이그레이션합니다. 문서와 테스트 코드가 새로운 설정 및 실행 워크플로우를 반영하도록 업데이트됩니다.

변경 사항

Cohort / File(s) 요약
문서 마이그레이션
CONTRIBUTING.md, README.md, manual/installation.md, manual/api-reference.md
pip install -e ".[dev]" 및 수동 python3.10 -m venv .venv 대신 uv sync --frozen --all-extras를 사용하도록 변경. MinerU 설치를 uv pip install --python .venv/bin/python로 변경. 테스트 및 서버 실행을 uv run pytestuv run uvicorn으로 변경. Windows 경로 참고사항 추가.
테스트 업데이트
tests/test_manual_docs.py, tests/test_readme.py, tests/test_truth_source_alignment.py
기존 pip install 및 수동 virtualenv 명령 사용을 검증하는 테스트를 uv 기반 명령 사용으로 변경. 새로운 테스트 함수 추가: test_installation_doc_uses_uv_first_setup_and_verification_commands(), test_installation_doc_includes_manual_api_healthcheck_commands(), test_api_reference_uses_uv_run_server_command(), test_installation_doc_notes_windows_uv_python_path_equivalent(), test_readme_uses_uv_sync_for_repo_setup(), test_readme_documents_uv_run_entrypoints(), test_repo_docs_note_windows_uv_python_path_equivalent(), test_public_docs_drop_stale_pip_setup_examples(). 기존 pip 및 venv 명령이 문서에서 제거되었는지 확인하는 검증 추가.

예상 코드 리뷰 시간

🎯 3 (중간) | ⏱️ ~20분

축하 시

🐰 우리의 프로젝트가 현대로 도약하네요!
uv의 빠른 손길로 의존성을 관리하고,
테스트도 더욱 깔끔하게 구성되었네요.
가상환경의 시대는 물러나고,
새로운 시대가 밝아온다네요! 🌟✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and concisely summarizes the main change: updating public documentation to align with uv-first setup guidance.
Description check ✅ Passed The pull request description includes a clear summary of changes, verification steps, and explains the documentation updates with uv commands. However, it does not include the 'Git Flow target' section from the required template.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/uv-first-public-setup

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

@seonghobae

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown
✅ 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 coderabbitai 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.

🧹 Nitpick comments (1)
manual/installation.md (1)

79-85: 로컬 스모크 예시는 127.0.0.1 바인딩으로 좁히는 것을 권장합니다.

문서 목적이 “로컬 상태 점검”이라면 외부 인터페이스 노출 없이 loopback 바인딩이 더 안전합니다. (동시에 tests/test_manual_docs.py의 기대 문자열도 함께 갱신 필요)

권장 수정안
-uv run uvicorn --app-dir src newsdom_api.main:app --host 0.0.0.0 --port 8000 --reload
+uv run uvicorn --app-dir src newsdom_api.main:app --host 127.0.0.1 --port 18000 --reload
...
-curl -sS http://127.0.0.1:8000/health
+curl -sS http://127.0.0.1:18000/health

Also applies to: 87-87

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@manual/installation.md` around lines 79 - 85, Change the API server bind in
the uvicorn example from public to loopback by replacing the --host 0.0.0.0 in
the uvicorn command example (newsdom_api.main:app) with --host 127.0.0.1, and
ensure the curl health check still targets http://127.0.0.1:8000/health; also
update the corresponding expected string in tests/test_manual_docs.py (and the
other occurrence noted at lines around the second example) so tests reflect the
loopback binding and local-only example.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@manual/installation.md`:
- Around line 79-85: Change the API server bind in the uvicorn example from
public to loopback by replacing the --host 0.0.0.0 in the uvicorn command
example (newsdom_api.main:app) with --host 127.0.0.1, and ensure the curl health
check still targets http://127.0.0.1:8000/health; also update the corresponding
expected string in tests/test_manual_docs.py (and the other occurrence noted at
lines around the second example) so tests reflect the loopback binding and
local-only example.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b4fb8ca8-dfc5-42b4-8248-39a79a7ff331

📥 Commits

Reviewing files that changed from the base of the PR and between 83c84a1 and b3d84ae.

📒 Files selected for processing (7)
  • CONTRIBUTING.md
  • README.md
  • manual/api-reference.md
  • manual/installation.md
  • tests/test_manual_docs.py
  • tests/test_readme.py
  • tests/test_truth_source_alignment.py

@seonghobae
seonghobae merged commit ae12473 into chore/security-manual-hardening Apr 10, 2026
10 checks passed
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