Skip to content

📝 docs: Add mkdocs-shadcn documentation site#3

Merged
heumsi merged 20 commits intomainfrom
docs/add-mkdocs-shadcn-site
Mar 31, 2026
Merged

📝 docs: Add mkdocs-shadcn documentation site#3
heumsi merged 20 commits intomainfrom
docs/add-mkdocs-shadcn-site

Conversation

@heumsi
Copy link
Copy Markdown
Owner

@heumsi heumsi commented Mar 31, 2026 •
edited
Loading

Summary

  • mkdocs + mkdocs-shadcn 테마 기반 문서 사이트 구축
  • Getting Started, Guide (Rules, Apply & Modules, Include/Exclude, Inline Ignore), Cookbook (7개 레시피), Reference (CLI, Pre-commit, Contributing, Changelog) 섹션 구성
  • GitHub Actions 워크플로우로 main 브랜치 push 시 GitHub Pages 자동 배포

Test plan

  • uv run mkdocs serve로 로컬에서 모든 페이지 렌더링 확인
  • uv run mkdocs build --strict로 빌드 에러 없음 확인
  • GitHub Pages 배포 후 https://heumsi.github.io/python-naming-linter/ 접속 확인
  • 사이드바 네비게이션이 모든 섹션을 올바르게 표시하는지 확인

🤖 Generated with Claude Code

heumsi and others added 20 commits March 31, 2026 14:45
@heumsi @claude
📝 docs: Add mkdocs-shadcn setup with home page
4ba2dd5 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@heumsi @claude
📝 docs: Add getting started section
e6a5db9 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@heumsi @claude
📝 docs: Add guide section
703dd7b 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@heumsi @claude
📝 docs: Add cookbook section
d35a2ea 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@heumsi
📝 docs: Add CLI, pre-commit, contributing, and changelog pages
8df804a
@heumsi
👷 ci: Add docs deployment workflow for GitHub Pages
16d1568
@heumsi @claude
🔧 chore: Remove superpowers specs and plans
1887b47 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
🔧 chore: Add site/ to gitignore and remove build output
60ff8c0 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Move CLI/pre-commit/contributing/changelog into Reference group
0ee2b4f 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Enrich guide pages with more examples and consistent style
ea12c67 
- Add comprehensive examples for every filter value and naming constraint
- Unify last section heading to "## Summary" across all guide pages
- Fix heading capitalization to Title Case consistently

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Unify guide page structure and style
070af35 
- Shorten inline-ignore intro to one sentence
- Add apply: blocks to all naming-constraints YAML examples
- Promote rule type headings from H3 to H2 in rules.md
- Remove violation message examples from naming-constraints
- Unify "Accepted value" to plural form
- Convert inline-ignore Summary from bullets to table

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Unify intro section heading to "Structure"
9e65a81 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Add "Types" grouping heading to rules, filters, naming-constr…
d36a9a1 
…aints

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Unify guide page structure with Structure/Types pattern
9aeb40b 
- Add "## Structure" to filters and naming-constraints
- Reorganize apply-and-modules: merge Module Path Patterns, Wildcards,
  Named Capture under "## Module Patterns" as H3 items
- Remove unnecessary Inline Syntax section

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Split rule types into separate page under Rules section
1a6138c 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Flatten Rules nav to fix sidebar visibility in mkdocs-shadcn
7d7b401 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Merge rule-types, filters, naming-constraints into single Rul…
d46b582 
…es page

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Add Fields table under Structure in Rules page
641120d 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Rename "include only" / "exclude only" to "Only include" / "O…
e697d85 
…nly exclude"

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi @claude
📝 docs: Change site name to "Python Naming Linter"
d38bad4 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi heumsi merged commit 6efdbfd into main Mar 31, 2026
5 checks passed
@heumsi heumsi deleted the docs/add-mkdocs-shadcn-site branch March 31, 2026 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@heumsi