claude-code-best-practice/.claude/rules/markdown-docs.md

Glob: **/*.md

Documentation Standards

• Keep files focused and concise — one topic per file
• Use relative links between docs (e.g., ../best-practice/claude-memory.md), not absolute GitHub URLs
• Include back-navigation link at top of best-practice and report docs (see existing files for pattern)
• When adding a new concept or report, update the corresponding table in README.md (CONCEPTS or REPORTS)

Structure Conventions

• Best practice docs go in best-practice/
• Implementation docs go in implementation/
• Reports go in reports/
• Tips go in tips/
• Changelog tracking goes in changelog/<category>/

Formatting

• Use tables for structured comparisons (see README CONCEPTS table as reference)
• Use badge images from !/tags/ for visual consistency when linking best-practice or implementation docs
• Keep headings hierarchical — don't skip levels (e.g., don't jump from ## to ####)