docs-structure

A set of rules for organizing Markdown documentation in a project’s docs or documentation folders. It recommends clear folders, file names, indexes, links, and categories such as guides, concepts, tutorials, and references.

In plain words
What is it for?
Use it when adding or reorganizing project documentation, navigation pages, tutorials, API references, examples, troubleshooting notes, or contribution guides.
Why use it?
It prevents documentation from becoming difficult to browse or inconsistent as the project grows.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/jimmypocock/cursor-rules/docs-structure
Clone the repo
git clone --depth 1 https://github.com/jimmypocock/cursor-rules

Made for: Cursor.

Per session 8 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 777 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00008 $0.00777
Opus 5 $0.00004 $0.00388
Sonnet 5 $0.00002 $0.00155
Haiku 4.5 $0.00001 $0.00078

Measured yesterday against content hash 9256bd69a5bd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-structure scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/docs-structure.mdc · 103 lines

How it starts

The opening of the file, as written. The whole thing — 103 lines — stays where its author put it; the contents beside it link to each section on GitHub.


Description: Best practices for organizing the docs/ directory Globs: /docs//.md, /documentation//.md

Documentation Structure Standards

@base.mdc @readme-documentation.mdc

Documentation Organization

  • Create a clear, logical hierarchy for documentation files
  • Use a consistent naming convention (kebab-case recommended)
  • Group related documents in subdirectories
  • Include an index.md in each directory for navigation
  • Maintain a consistent structure across all documentation
  • Link between related documentation sections
  • Create sidebar navigation for complex documentation
  • Use folders to separate different documentation types

Core Documentation Types

  • Guides/ - Step-by-step instructions for common tasks
  • Concepts/ - Explanations of key ideas and architecture
  • Reference/ - Detailed technical reference information
  • Tutorials/ - Complete walkthroughs for beginners
  • API/ - API documentation if applicable
  • Examples/ - Example implementations and use cases
  • Troubleshooting/ - Solutions for common problems
  • Contributing/ - Guidelines for project contributors

Documentation Files Structure

  • Begin each file with a descriptive title (# Title)
  • Include a brief introduction explaining the document's purpose
  • Use consistent heading levels (## for main sections, ### for subsections)
  • Include a table of contents for longer documents
  • Add "Next Steps" or "See Also" sections at the end
  • Include metadata (author, date, version) when relevant
  • End with links to related documentation
  • Keep individual files focused on a single topic

Technical Writing Best Practices

  • Write in a clear, conversational style
  • Use active voice and present tense
  • Explain technical terms on first use
  • Use consistent terminology throughout
  • Create glossaries for complex terminology
  • Include diagrams for complex concepts
  • Break long processes into numbered steps
  • Use tables to organize structured information

Document Types and Templates

  • Concept Document - Explain a single concept thoroughly
  • How-To Guide - Task-focused instructions
  • Tutorial - Start-to-finish walkthrough with context
  • Reference - Comprehensive technical details
  • Example - Working code with explanation
  • FAQ - Concise answers to common questions
  • Architecture Document - System design and rationale
  • Decision Record - Document important decisions

Read the full file on GitHub · 103 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 103 lines · 8 tokens per session scan A 9256bd69a5bd

Subscribe to this mod's changes

docs-structure is a cursor rule published in the GitHub repository jimmypocock/cursor-rules (8 stars, last pushed 1y ago), licensed MIT. It adds 8 tokens to every session and 777 once invoked, about $0.0000 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.