docs: align public setup guidance with uv defaults - #44
Conversation
📝 Walkthrough요약이 풀 요청은 프로젝트 전반의 개발 환경 설정을 변경 사항
예상 코드 리뷰 시간🎯 3 (중간) | ⏱️ ~20분 축하 시
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
🧹 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/healthAlso 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
📒 Files selected for processing (7)
CONTRIBUTING.mdREADME.mdmanual/api-reference.mdmanual/installation.mdtests/test_manual_docs.pytests/test_readme.pytests/test_truth_source_alignment.py
Summary
README.md,CONTRIBUTING.md,manual/installation.md, andmanual/api-reference.mdwith the repository's uv-first install/run/test defaultsuv sync,uv pip install, anduv runcommands, including the local/healthsmoke path and Windows interpreter noteVerification
uv run pytestuv run pytest --cov=src/newsdom_api --cov-branch --cov-report=term-missing --cov-fail-under=100uv run mkdocs build --strictuv run uvicorn --app-dir src newsdom_api.main:app --host 127.0.0.1 --port 18000+curl -fsS http://127.0.0.1:18000/healthSummary by CodeRabbit
설명서
테스트