documentation

A set of rules for keeping project documentation organised. It separates instructions for the coding agent from records about the project's architecture, features, plans, and requirements.

In plain words
What is it for?
It helps structure README files and documents for architecture, features, tasks, requirements, and project state.
Why use it?
It prevents project facts, temporary notes, and agent instructions from being mixed together. This makes the documentation easier to maintain and use as a long-term reference.

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

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 345 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.00345
Opus 5 $0.00000 $0.00172
Sonnet 5 $0.00000 $0.00069
Haiku 4.5 $0.00000 $0.00034

Measured yesterday against content hash aa84645e5242, 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 · 26 lines

What it actually says

Repository Documentation Structure

Segregation of Rules vs. Project State

  • .cursor/rules/ defines HOW the AI behaves (logic, style, constraints).
  • docs/ contains WHAT the project is (state, architecture, roadmap).
  • Never store session-specific state in the rules folder.

Required Documents

The following structure is the project's "Long-Term Memory." All docs MUST live in the docs/ folder (except the root README.md).

  1. README.md (Root) - High-level overview of the project, setup instructions, and quick start guide.
  2. docs/detailed.md - In-depth technical architecture, data flow, and complex logic (e.g., anti-bot strategies).
  3. docs/features.md - Inventory of implemented vs. planned features. Note: This file describes capabilities; it must NOT contain implementation checkboxes or real-time tracking notes (those belong in docs/plan.md).
  4. docs/todo.md - Active bug list, technical debt, and future enhancements.
  5. docs/plan.md - Mandatory active execution plan for the current task.
  6. docs/requirements.md - Third-party dependencies, system requirements, and environment setup details.

Doc Maintenance Rules

  • Consistency: Keep README.md in sync with docs/features.md.
  • SOP Adherence: Every session begins by reading the docs/ folder and README.md.
  • Updates: Every completed task must conclude with an update to the relevant documentation files.
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 · 26 lines · 345 tokens per session scan A aa84645e5242

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository raysalem/real_estate_sd_web_scraper (2 stars, last pushed 6mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 345 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.