ConsensysConsensys/linea-monorepo/.cursor/rules/documentation.mdc

linea-monorepo / rules

Cursor rule126 starsChanged 3 months agoApache-2.0View on GitHub

Documentation discovery index for Lineth monorepo

We split this documentation.mdc into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is 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.
1
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
If this file conflicts with /AGENTS.md, follow /AGENTS.md.
line 12

≈ “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

documentation.mdc

---
description: Documentation discovery index for Lineth monorepo
globs: ["**/*"]
alwaysApply: true
---

# Documentation Discoverability

## Precedence

- Canonical repository instructions: `/AGENTS.md`
- If this file conflicts with `/AGENTS.md`, follow `/AGENTS.md`.

## Agent Entry Points

- Codex: `/AGENTS.md`
- Cursor: `/.cursor/rules/documentation.mdc`, `/.cursor/BUGBOT.md`, then `/AGENTS.md`
- Claude Code: `/CLAUDE.md`, then `/AGENTS.md`
- GitHub Copilot: `/.github/copilot-instructions.md`, then `/AGENTS.md`

## Context and Documentation

- Repository overview: `/README.md`
- Contributing: `/CONTRIBUTING.md`, `/docs/contribute.md`
- Setup: `/docs/get-started.md`, `/docs/local-development-guide.md`
- Architecture: `/docs/architecture-description.md`
- Engineering guidelines: `/docs/development-guidelines.md`
- Security: `/docs/security.md`
- Audits: `/docs/audits.md`

## Rules

- Cursor review and quality rules: `/.cursor/BUGBOT.md`
- Security logging rules: `/.cursor/rules/security-logging-guidelines/RULES.md`
- API/versioning rules: `/.cursor/rules/versioning-guidelines/RULES.md`
- Smart-contract specific Cursor rule: `/.cursor/rules/smart-contract-guidelines/RULE.md`

## Local Skills

- Squash Bugbot skill: `/.agents/skills/squash-bugbot/SKILL.md`
- Invocation: `/squash-bugbot <PR_NUMBER>` in agents that support project skills.
- This repository does not maintain a separate `/.cursor/skills` copy; use the canonical `/.agents/skills` skill.

## Package-Specific Agent Docs

- `/contracts/AGENTS.md`
- `/coordinator/AGENTS.md`
- `/prover/AGENTS.md`
- `/tracer/AGENTS.md`
- `/sdk/AGENTS.md`
- `/linea-besu/plugins/AGENTS.md`
- `/transaction-exclusion-api/AGENTS.md`
- `/e2e/AGENTS.md`

## Note

This file is an index only. Do not duplicate commands or conventions maintained in `/AGENTS.md`.

Download now (ZIP)

Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 3,978 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository20 other files it gives its agents.
- AGENTS.mdAGENTS.md
- contracts/AGENTS.mdAGENTS.md
- coordinator/AGENTS.mdAGENTS.md
- e2e/AGENTS.mdAGENTS.md
- maru/AGENTS.mdAGENTS.md
- postman/AGENTS.mdAGENTS.md
- prover/AGENTS.mdAGENTS.md
- prover-ray/AGENTS.mdAGENTS.md
- tracer/AGENTS.mdAGENTS.md
- transaction-exclusion-api/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/security-logging-guidelines/EXAMPLES.mdCursor rule
- .cursor/rules/security-logging-guidelines/RULES.mdCursor rule
- .cursor/rules/smart-contract-guidelines/RULE.mdCursor rule
- .cursor/rules/versioning-guidelines/EXAMPLES.mdCursor rule
- .cursor/rules/versioning-guidelines/RULES.mdCursor rule
- developing-smart-contractsSkill
- linea-dependency-maintenanceSkill
- squash-bugbotSkill

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.

Check your setup, free