Skip to content

chore: docs를 allowlist 방식으로 차단 - #16

Merged
jeongph merged 2 commits into
mainfrom
chore/docs-allowlist
Jul 28, 2026
Merged

chore: docs를 allowlist 방식으로 차단#16
jeongph merged 2 commits into
mainfrom
chore/docs-allowlist

Conversation

@jeongph

@jeongph jeongph commented Jul 28, 2026

Copy link
Copy Markdown
Member

공개 저장소이므로 docs/ 아래도 저장소 루트와 같은 원칙(전체 차단 후 선택 허용)을 적용한다.

!/docs/로 통째 허용돼 있어, 로컬 산출물(세션 의도 기록 docs/intent/, 작업 노트 등)을 만들면 그대로 공개 저장소에 올라갈 수 있었다. 저장소 위생 규약이 금지하는 바로 그 상황.

변경

!/docs/
/docs/*              # 기본 차단
!/docs/conventions/  # 공개 대상만 허용
!/docs/maps/

검증

  • 추적 유지: docs/conventions/documentation.md·shipshape.md·docs/maps/projects.md
  • 차단 확인: docs/intent/**·docs/scratch/**·docs/tmp.md
  • git status에 의도치 않은 변화 없음

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Clarified how conventions and maps documentation are managed and shared.
    • Updated usage guidance to explain which documentation is delivered to individual repositories.
    • Added clearer guidance for keeping repository maps current as repository structures change.
  • Configuration

    • Refined documentation handling so conventions are included in generated guidance, while maps remain available as repository reference material.
    • Restricted tracked documentation to approved public documentation areas.

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 43ab6068-06d6-497a-abed-25414d626b70

📥 Commits

Reviewing files that changed from the base of the PR and between eba3ac5 and 5d13ffa.

📒 Files selected for processing (4)
  • .gitignore
  • README.md
  • policies/core.yaml
  • rutter.yaml

📝 Walkthrough

Walkthrough

The PR makes docs/conventions/ the sole synthesized documentation target, keeps docs/maps/ as a directly read reference, updates ignore rules for both directories, and clarifies related README and policy wording.

Changes

Documentation synthesis boundary

Layer / File(s) Summary
Define synthesized documentation targets
rutter.yaml, README.md
docs/conventions/ remains the only synthesized documentation directory, while README guidance states that docs/maps/ is not delivered to individual repositories.
Preserve and describe reference maps
.gitignore, policies/core.yaml
Ignore rules selectively allow docs/conventions/ and docs/maps/, and the maps.update-first policy describes map management in the rutter repository.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • followingseas/rutter#10: Related updates distinguish docs/maps from the synthesized docs/conventions path.
  • followingseas/rutter#13: Related changes make docs/conventions/ the sole synthesis target and update associated policy documentation.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: applying an allowlist-based block to the docs directory.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-allowlist

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

@jeongph
jeongph merged commit a3be43a into main Jul 28, 2026
2 checks passed
@jeongph
jeongph deleted the chore/docs-allowlist branch July 28, 2026 22:37
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