doc.linea / rules
Cursor rule478 starsChanged 3 months agoApache-2.0View on GitHub
Required spelling, casing, and naming for product terms and technical concepts across docs.linea.build.
We split this terminology.mdc into the rules it gives an agent
6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
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
- Distinctive: line 11
Use "dapp" rather than "dApp" or "DApp", and capitalize like any other noun.
- Distinctive: line 12
Use "onchain" rather than "on-chain" or "on chain", and capitalize like any other noun.
- Distinctive: line 13
Use "offchain" rather than "off-chain" or "off chain", and capitalize like any other noun.
- Distinctive: line 14
Use lowercase "web2" and "web3" (never "Web2"/"Web3"), except at the start of a sentence.
- Very specific: line 26
Do not assert which term applies to a given page from memory.
- Distinctive: line 38
Do not treat deployment and network as interchangeable, and do not switch between them at random on the same page.
≈ “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.
Files
---
description: Required spelling, casing, and naming for product terms and technical concepts across docs.linea.build.
globs: docs/**/*.{mdx,md}
alwaysApply: false
---
# Terminology
## Casing of common terms
- Use "dapp" rather than "dApp" or "DApp", and capitalize like any other noun.
- Use "onchain" rather than "on-chain" or "on chain", and capitalize like any other noun.
- Use "offchain" rather than "off-chain" or "off chain", and capitalize like any other noun.
- Use lowercase "web2" and "web3" (never "Web2"/"Web3"), except at the start of a sentence.
## Linea vs. Lineth naming
Linea and Lineth are related but distinct terms, and getting them right matters for
technical accuracy:
- **Linea** is the public Mainnet network, brand, token, tokenomics, governance, and the
Linea SDK.
- **Lineth** is the open-source ZK-rollup stack, protocol, codebase, components, onchain
contracts, and tooling that Linea Mainnet and other networks are built on.
Do not assert which term applies to a given page from memory. The canonical explanation,
including the tab-to-product mapping (which tabs document Linea vs. Lineth), lives at
[Linea and Lineth](/protocol/linea-vs-lineth) (`docs/protocol/linea-vs-lineth.mdx`). Read
that page first, and match the naming already used on neighboring pages in the same
section.
Where a page already uses a term consistently, keep matching it rather than introducing a
new term. If you're unsure whether a name is final, leave the existing wording in place and
note your question in the pull request description rather than guessing.
## Lineth deployment vs. Lineth network
Do not treat **deployment** and **network** as interchangeable, and do not switch between
them at random on the same page.
- A **deployment** is the operator's instance of the stack: topology, access control,
data availability, finalization layer, and endpoints. Use it for how the stack is run.
- A **network** is the chain that instance produces: it has a chain ID and state, and it
sends or claims messages. Use it for chain-to-chain behavior.
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 repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .cursor/rules/content-structure.mdcCursor rule
- .cursor/rules/contributor-workflow.mdcCursor rule
- .cursor/rules/css-styling.mdcCursor rule
- .cursor/rules/editorial-voice.mdcCursor rule
- .cursor/rules/markdown-formatting.mdcCursor rule
- static/llms.txtllms.txt
- author-doc-pageSkill
- linea-dependency-maintenanceSkill
- pr-content-reviewSkill
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.