Skip to content

📝 docs: Add documentation site with mkdocs-shadcn#23

Merged
heumsi merged 13 commits intomainfrom
docs/site
Mar 31, 2026
Merged

📝 docs: Add documentation site with mkdocs-shadcn#23
heumsi merged 13 commits intomainfrom
docs/site

Conversation

@heumsi
Copy link
Copy Markdown
Owner

@heumsi heumsi commented Mar 31, 2026

Summary

  • Add documentation site using mkdocs-shadcn theme
  • Structure: Getting Started, Guide (Rules), Cookbook (6 recipes), Reference
  • Cookbook covers: Layered/Hexagonal/Clean Architecture, Named Capture Recipes, Monorepo, Gradual Adoption
  • Deploy docs via GitHub Pages in publish workflow (on release tag push)
  • Slim down README to link to docs site

Pages

  • Getting Started: Installation, Quick Start, Configuration
  • Guide: Rules (structure, import categories, allow/deny, patterns, rule merging, inline ignore)
  • Cookbook: Layered Architecture, Hexagonal Architecture, Clean Architecture, Named Capture Recipes, Monorepo, Gradual Adoption
  • Reference: Config Schema, CLI, Pre-commit, Contributing, Changelog

Test plan

  • mkdocs build --strict passes
  • Local preview with mkdocs serve renders all pages correctly
  • After merge + release tag, verify GitHub Pages deployment

🤖 Generated with Claude Code

heumsi and others added 13 commits March 31, 2026 14:46
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Move configuration to getting-started, CLI and pre-commit to reference,
add cookbook overview, contributing, and changelog pages. Update mkdocs.yml
with theme options and markdown extensions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Consolidate patterns, rule-merging, and inline-ignore into guide/rules.md
for better cohesion.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Unify page structure, headings, and tone across all docs pages
to be consistent with the python-naming-linter documentation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add Fields table, behavior mode examples with Pass/Violation tables,
pattern matching tables, practical inline ignore examples, and
summary section to match python-naming-linter documentation style.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove separate docs.yaml workflow. Add docs job to publish.yaml
using GitHub Pages official deployment (upload-pages-artifact +
deploy-pages) to match python-naming-linter.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@heumsi heumsi merged commit 123bcd5 into main Mar 31, 2026
5 checks passed
@heumsi heumsi deleted the docs/site branch March 31, 2026 08:36
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