Skip to content

docs: pin the supported MkDocs toolchain stance - #43

Merged
seonghobae merged 1 commit into
chore/security-manual-hardeningfrom
chore/docs-toolchain-hold
Apr 10, 2026
Merged

docs: pin the supported MkDocs toolchain stance#43
seonghobae merged 1 commit into
chore/security-manual-hardeningfrom
chore/docs-toolchain-hold

Conversation

@seonghobae

@seonghobae seonghobae commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • document that the repository currently supports the MkDocs 1.x docs stack and intentionally holds mkdocs<2.0 plus mkdocs-material<9.7
  • make the docs extra carry an explicit comment explaining why the current Material-based manual stack stays below MkDocs 2.0 for now
  • add metadata regressions so future edits cannot silently drop the docs-toolchain hold or its maintainer-facing explanation

Verification

  • uv run pytest tests/test_project_metadata.py -q
  • uv run pytest tests/test_project_metadata.py tests/test_workflow_security.py -q
  • uv run pytest --cov=src/newsdom_api --cov-branch --cov-report=term-missing --cov-fail-under=100
  • uv run mkdocs build --strict
  • npx -y markdownlint-cli2@0.18.1 CONTRIBUTING.md

Git Flow target

Summary by CodeRabbit

릴리스 노트

  • 문서

    • 문서 빌드 도구체인이 MkDocs 1.x 버전에서 유지될 예정임을 명시했습니다.
    • 지원되는 버전 제약 사항을 기여 가이드라인에 추가했습니다.
  • 테스트

    • 문서 빌드 도구체인 버전 제약 조건을 검증하는 새로운 테스트를 추가했습니다.

@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 028c1e30-5674-445f-b1fa-acb0285ec388

📥 Commits

Reviewing files that changed from the base of the PR and between 1af74b0 and a0e3ac9.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • pyproject.toml
  • tests/test_project_metadata.py

📝 Walkthrough

Walkthrough

MkDocs 1.x 라인 유지 정책을 문서화하고 버전 제약 조건(mkdocs<2.0, mkdocs-material<9.7)을 명시했으며, 이러한 제약 조건의 준수를 검증하는 메타데이터 테스트 3개를 추가했습니다.

Changes

Cohort / File(s) Summary
설명서 및 정책 문서화
CONTRIBUTING.md, pyproject.toml
MkDocs 1.x 라인 유지 정책과 버전 제약 조건을 문서화했습니다. uv.lock이 현재 지원되는 설명서 빌드의 권위 있는 소스임을 명시했습니다.
메타데이터 준수 테스트
tests/test_project_metadata.py
pyproject.tomlCONTRIBUTING.md에서 MkDocs 버전 제약 조건과 설명서 도구 체인 정책을 검증하는 3개의 새로운 테스트를 추가했습니다.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 MkDocs 일 점 엑스, 우리의 길을 밝히고
버전 제약으로 안정성을 다지며
테스트 삼 개가 모두를 지켜내네
마이그레이션 길도 함께 표시하고
준비 문서 또한 튼튼하게! 🔒

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive 설명이 주요 변경 사항을 다루고 검증 단계를 제공하지만, 템플릿의 필수 섹션 일부가 누락되어 있습니다. 설명에 'Git Flow target' 섹션은 있지만 표준 템플릿의 체크박스 형식 검증 단계를 명시적으로 포함하고, 필요한 경우 핫픽스 백머지 노트를 추가해야 합니다.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed 제목이 변경 사항의 핵심을 명확하게 설명합니다. MkDocs 도구체인 버전 고정에 대한 실질적인 변경 사항과 일치합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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/docs-toolchain-hold

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.

@seonghobae
seonghobae merged commit 83c84a1 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