agentleFS
alchemyplatformalchemyplatform/aa-sdk/.cursor/rules/docs-reference.mdc

aa-sdk / rules

Cursor rule321 starsChanged 5 months agoMITView on GitHub

Documentation and generated SDK reference guidance

We split this docs-reference.mdc into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Treat docs/pages/reference/ as TypeDoc-generated output.

    line 10
  2. Very specific:

    Run pnpm run docs:sdk and pnpm run lint:write when public API docs should change.

    line 12
  3. Very specific:

    Read .agents/skills/documentation/ for full docs and generated-output rules.

    line 13

≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
docs-reference.mdc
---
description: Documentation and generated SDK reference guidance
globs: "docs/**/*.mdx,docs/docs.yml,typedoc.json,tsconfig.typedoc.json,scripts/generate-typedoc-yaml.ts"
alwaysApply: false
---

# Documentation Reference

- Preserve code snippet behavior in docs; do not rename SDK APIs or change imports as style edits.
- Treat `docs/pages/reference/**` as TypeDoc-generated output.
- Change source TSDoc, exports, `typedoc.json`, or generation scripts before regenerating reference docs.
- Run `pnpm run docs:sdk` and `pnpm run lint:write` when public API docs should change.
- Read `.agents/skills/documentation/` for full docs and generated-output rules.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.