documentation

A set of project rules for keeping user-facing documentation aligned with an application’s API, behavior, screens, and technical structure.

In plain words
What is it for?
Use it when changing APIs, visible behavior, routes, interface elements, package structure, or project conventions to identify which documentation files need updates.
Why use it?
Documentation can become misleading when features or interfaces change without updating the related guides.

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/vepo/issues/documentation
Clone the repo
git clone --depth 1 https://github.com/vepo/issues

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 479 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.00000 $0.00479
Opus 5 $0.00000 $0.00239
Sonnet 5 $0.00000 $0.00096
Haiku 4.5 $0.00000 $0.00048

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

Security

Grade A, and why

documentation 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/documentation.mdc · 48 lines

What it actually says

Documentation — read and maintain

Before changing API or user-visible behaviour

  1. Skim AGENTS.md doc map.
  2. Update the lowest complexity doc that covers the feature.

After changes — update when relevant

Change Update
New domain term or invariant domain-specification.md
New/changed UI route feature-catalog.md
New/changed UI element (class, component, pattern) ui-elements-gallery.md
Flat UI / visual language change ui-elements-gallery.md § Flat UI + issues-ux.mdc
Package, API surface, patterns ARCHITECTURE.md
Doc debt closed conventions-checklist.md
New/changed user-facing feature README.md § Features — see readme.mdc
New product idea (not yet analyzed) backlog.md — ordered table; see backlog-management.mdc
README badges or project name README.md

Complexity order

  1. domain-specification — vocabulary and rules
  2. feature-catalog — routes and click paths
  3. ui-elements-gallery — reusable UI components and patterns
  4. ARCHITECTURE — technical structure
  5. README — pitch and links

Quality bar

  • No stale type names after renames — grep docs when renaming.
  • Cross-link; avoid duplicating large blocks.
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 · 48 lines · 0 tokens per session scan A 97e2acfc39e9

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository vepo/issues (8 stars, last pushed 1mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 479 tokens. 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.