docs: README 와 코드가 어긋난 곳을 맞춘다

[nalbam]

요약

README 와 코드를 대조해 어긋난 서술 두 건과, 규칙을 지키지 않던 스킬 하나를 고쳤다.
빠진 문서보다 틀린 문서가 먼저다 — 셋 다 읽는 사람을 잘못된 곳으로 보내고 있었다.

변경

fix: declare diagram-design's SaveFile fallback in compatibility

README 는 "빌트인에 기대는 스킬은 compatibility 프론트매터로 밝힌다"고 규정한다.
diagram-design 만 그 서술이 본문(SKILL.md:71-72)에만 있어 프론트매터가 비어 있었다.
같은 계약을 쓰는 나머지 넷(html-report·html-wireframe·html-prototype·html-explainer)과
자리를 맞췄다. 문구는 정적 산출물이라는 점이 같은 html-wireframe 과 동일하다.

docs: fix the extension-doc example and document the validator's tests

• 확장 문서 예시가 document 를 한 줄 description 으로 보여 주는데, 실제
  document.md 는 > 폴딩을 쓴다. 게다가 바로 다음 줄이 document 를 폴딩 사례로
  지목해 예시와 설명이 서로를 부정하고 있었다. 예시를 실제로 한 줄인 notion 으로 바꿨다.
• scripts/test_validate.py 와 CI 의 unittest 단계가 README 어디에도 없었다.
  "Validate before merging" 절에 실행 명령과 이 테스트가 무엇을 고정하는지를 넣고,
  마지막 문장을 CI runs both 로 고쳤다.

chore: stop tracking compiled Python bytecode

scripts/__pycache__/validate.cpython-312.pyc 가 저장소에 커밋돼 있었고 .gitignore
에는 __pycache__/ 항목이 없었다. 둘 다 정리했다.

Breaking Changes

없다. diagram-design 의 compatibility 는 본문이 이미 규정하던 동작을 프론트매터로
옮긴 것이라 런타임 동작은 그대로다.

검증

• python3 scripts/validate.py — 7 plugins, 24 skills 통과. 경고 8건은 기존
  private-HTTP 배포 예외로 이 PR 과 무관하다.
• python3 -m unittest discover -s scripts -p 'test_*.py' — 14 tests OK.
• 추가한 compatibility 는 스펙 상한 500자 안이다.
• README 가 가리키는 파일 경로와 앵커 링크는 전부 실재함을 확인했다.

Summary by CodeRabbit

• Documentation

  • Updated the MCP extension example to use the Notion server, including revised headings and descriptions.
  • Added validation test command instructions.
  • Clarified that validation runs on both pull requests and pushes.
  • Expanded diagram guidance for saving HTML files and reporting browser-rendering verification status.

• Chores

  • Added Python cache directories to ignore rules.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3166822c-ba31-4233-b1ed-1ff09e4645ab

📥 Commits

Reviewing files that changed from the base of the PR and between 2d41e12 and e624907.

⛔ Files ignored due to path filters (1)

• scripts/__pycache__/validate.cpython-312.pyc is excluded by !**/*.pyc

📒 Files selected for processing (3)

• .gitignore
• README.md
• plugins/design/skills/diagram-design/SKILL.md

---

📝 Walkthrough

Walkthrough

The changes update repository ignores and documentation. The README now uses the Notion MCP example and documents two validation commands. Diagram skill guidance now defines SaveFile handling and browser-rendering disclosure.

Changes

Repository guidance

Layer / File(s)	Summary
Documentation and validation guidance README.md, plugins/design/skills/diagram-design/SKILL.md	The README uses the Notion MCP example and documents both validation commands. The diagram skill defines HTML or code-block output based on SaveFile availability and requires disclosure of unverified browser rendering.
Python cache ignore rule .gitignore	Python __pycache__/ directories are ignored.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: nalbam-me

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/sync-readme-with-code

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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