gilles/claude-code-best-practice

Files

T

Shayan Rais 29e19dfbe0 .claude/rules/markdown-docs: switch Glob heading to paths: YAML frontmatter

The '# Glob: **/*.md' markdown heading was a cargo-cult label — Claude Code
only parses YAML frontmatter with paths: for path-scoping. Without it, the
file loaded unconditionally on every session. Now correctly scoped via
paths: ["**/*.md"] and H1 retitled to 'Markdown Docs' for human readers.

Co-Authored-By: Claude <noreply@anthropic.com>

2026-04-20 00:07:46 +05:00

956 B

Raw Blame History

paths

paths

**/*.md

Markdown Docs

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 ####)