markdown-docs
Path rule for Markdown files in this repo: one topic per file, relative links between docs, and back-navigation links at the top of guides.
- Kind
- Rules
- Works with
- Claude Code
- Source
- shanraisshan/claude-code-best-practice @ 6d0844baf620
- Path
- .claude/rules/markdown-docs.md
- License
- MIT
- Jobs
- Documentation
InstallCopy it from the source repository, or sign in and let the assistant adapt it for your project.
# 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 `####`)