Skip to main content
rule CX Codex

docs-markdown — Claude Code rule: what it does, how to install

docs-markdown — a markdown documentation rule: command samples must run, project paths start at the root, and architecture notes have to match what the code does.

MIT ★ 1,198 updated 2026-10-23

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/rules/docs-markdown.md
Open on GitHub

What docs-markdown does

The rule lists what markdown in the repo has to look like. Command samples run and match the real scripts, file paths start from the project root, and any claim about the architecture reflects current code behaviour.

One bullet covers syncing. When a workflow changes, README.md, README-EN.md and its mirrors, ARCHITECTURE, SETUP, INSTALL and mcp/README all get edited in the same pass. Sections stay short, and troubleshooting gives real steps.

The frontmatter carries paths: **/*.md, so the rule fires on markdown only and leaves source files alone. The usual failure is fixing one README from that list and skipping the rest; the docs then contradict each other.

What it helps with

  • keep command samples in the docs runnable
  • use root-based file paths instead of guessed relative ones
  • update every affected README in a single pass after a workflow change
  • drop architecture claims the code no longer backs
  • trim a section down to concrete troubleshooting steps

Example prompts for the agent

  • Update README.md and ARCHITECTURE for the new startup flow, and check that every command in them actually runs.
  • Rewrite the install section of README-EN.md with root-based paths and real troubleshooting steps.
  • We reworked how mcp/README is structured — go through the other docs that reference it.

How to install docs-markdown

Manually: put the files in place

.claude/rules/docs-markdown.md

The paths frontmatter field limits the files

Step by step, with commands for each platform: AGENTS.md vs CLAUDE.md: what they are and which one to use

Questions about docs-markdown

How do I install docs-markdown in Claude Code?

Place the rule file in your project at .claude/rules/docs-markdown.md.

What does docs-markdown do?

It sets five requirements for markdown docs: runnable command samples, root-based paths, architecture notes that match the code, all affected docs updated together, and short sections with concrete troubleshooting.

Which files does the rule apply to?

Markdown files only, scoped by paths: **/*.md in the frontmatter. Source code and configs are outside it.

Source text

docs-markdown.md · MIT
---
paths:
  - "**/*.md"
---

# Documentation Rules

- Keep command examples executable and aligned with actual scripts.
- Use absolute or clearly rooted paths when discussing project files.
- When adding architecture claims, reflect current code behavior.
- Update all affected docs together (`README.md` landing, `README-EN.md` full guide and mirrors, `ARCHITECTURE`, `SETUP`, `INSTALL`, `mcp/README`) when workflows change.
- Prefer concise sections and concrete troubleshooting steps.

© hoangsonww · MIT · hoangsonww/Claude-Code-Agent-Monitor

Similar IDE rules

All IDE rules for Writing and docs →

From the same set155

The whole set →
ccam-productivity ccam-productivity — a hook that writes session start and end timestamps from Claude Code into a log file. Handy when you want to measure how long you actually work on tasks. CX Codex ★ 1,198repo stars ccam-cost-guard ccam-cost-guard tracks Claude Code spending and posts session stop events directly to the local Agent Monitor dashboard. CX Codex ★ 1,198repo stars ccam-analytics ccam-analytics is a Claude Code hook that streams session events to Agent Monitor for telemetry tracking. It triggers whenever a main session or subagent stops. CX Codex ★ 1,198repo stars integration-operator integration-operator is a Claude Code subagent that manages CCAM alerts, webhooks, push notifications, and SSH sources. It confirms changes first and hides secrets. CX Codex ★ 1,198repo stars backend-reviewer The backend-reviewer subagent reviews backend routes and hooks for regressions, data integrity risks, and missing tests. It works with Claude Code and Codex. CX Codex ★ 1,198repo stars frontend-react frontend-react — a React frontend rule for Claude and Claude that keeps UI edits small: explicit prop types, existing state patterns, routes left alone. CX Codex +1 ★ 1,198repo stars platform-admin platform-admin manages settings, hooks, data imports, backups, and MCP for Claude Code Agent Monitor. Confirms writes before updating. CX Codex ★ 1,198repo stars frontend-reviewer The frontend-reviewer subagent reviews React UI changes for behavior regressions, state mismatches, and broken user flows. Use it after frontend edits. CX Codex ★ 1,198repo stars

Project sponsors

Companies that keep this analytics open