documentation-sync

A documentation checklist for projects that use MkDocs and API reference pages.

In plain words
What is it for?
Use it when changing code, adding documentation or Markdown files, updating APIs, or reviewing documentation quality.
Why use it?
It helps keep documentation, examples, type hints, docstrings, navigation, and installation instructions aligned with code changes.

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/567-labs/instructor/documentation-sync
Clone the repo
git clone --depth 1 https://github.com/567-labs/instructor

Made for: Cursor.

Per session 249 This file is loaded in full into every session.
When invoked 249 The same file — it is already loaded in full.
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.00249 $0.00249
Opus 5 $0.00125 $0.00125
Sonnet 5 $0.00050 $0.00050
Haiku 4.5 $0.00025 $0.00025

Measured 2d ago against content hash dc7fc3a9e995, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-sync 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 2d ago.

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-sync.mdc · 36 lines

What it actually says

  • When making code changes:

    • Update related documentation files to reflect the changes
    • Check docstrings and type hints are up to date
    • Update any example code in markdown files
    • Review README.md if the changes affect installation or usage
  • When creating new markdown files:

    • Add the file to mkdocs.yml under the appropriate section
    • Follow the existing hierarchy and indentation
    • Use descriptive nav titles
    • Example:
      nav:
        - Home: index.md
        - Guides:
            - Getting Started: guides/getting-started.md
            - Your New File: guides/your-new-file.md
      
  • For API documentation:

    • Ensure new functions/classes are documented
    • Include type hints and docstrings
    • Add usage examples
    • Update API reference docs if auto-generated
  • Documentation Quality:

    • Write at grade 10 reading level (see simple-language.mdc)
    • Include working code examples
    • Add links to related documentation
    • Use consistent formatting and style
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. 2d ago First seen · 36 lines · 249 tokens per session scan A dc7fc3a9e995

Subscribe to this mod's changes

documentation-sync is a cursor rule published in the GitHub repository 567-labs/instructor (13,803 stars, last pushed 4d ago), licensed MIT. It adds 249 tokens to every session, about $0.0012 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-30.

Related

Other cursor rules, from other repositories

mempalace-recall-always

Always-on MemPalace recall — search the palace before answering about past work, people, projects, or prior decisions.

MemPalace/mempalace · 260 tokens

backend-python

Cursor rule "backend-python" from coeusyk/inference-x, covering backend python rules, stack assumptions, code style, fastapi conventions and schema conventions.

coeusyk/inference-x · 424 tokens

api-tester

Expert API testing specialist focused on comprehensive API validation, performance testing, and quality assurance across all systems and third-party integrations.

Treevu-ai/cli-market-world · 23 tokens

developer-advocate

Expert developer advocate specializing in building developer communities, creating compelling technical content, optimizing developer experience (DX), and driving platform adoption through authentic engineering engagement. Bridges product and engineering teams with external developers.

Treevu-ai/cli-market-world · 38 tokens

cursorrules

When making commits, always use the git-ai-commit CLI tool instead of regular git commit. This tool automatically generates AI-powered commit messages based on your staged changes.

the-cafe/git-ai-commit · 262 tokens

memory-bank

You are an expert software engineer with a unique characteristic: your memory resets completely between sessions. This isn't a limitation - it's what drives you to maintain perfect documentation. At the beginning of each dialogue, you rely ENTIRELY on your Memory Bank to understand the project and continue work…

alexeyleshchenko/fast-mcp-telegram · 1,623 tokens