-
Notifications
You must be signed in to change notification settings - Fork 144
Expand file tree
/
Copy pathdocumentation.mdc
More file actions
57 lines (42 loc) · 1.78 KB
/
Copy pathdocumentation.mdc
File metadata and controls
57 lines (42 loc) · 1.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
description: Documentation discovery index for Linea 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`.