editorial-voice

A set of writing rules for documentation published on docs.linea.build, covering headings, tone, clarity, terminology, and evergreen wording.

In plain words
What is it for?
Use it when editing or reviewing Linea documentation, especially headings, concept pages, reference material, and operational explanations.
Why use it?
It gives contributors a consistent way to write clear documentation without unexplained jargon, filler, or promotional language.

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/consensys/doc.linea/editorial-voice
Clone the repo
git clone --depth 1 https://github.com/Consensys/doc.linea

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 564 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.00564
Opus 5 $0.00000 $0.00282
Sonnet 5 $0.00000 $0.00113
Haiku 4.5 $0.00000 $0.00056

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

Security

Grade A, and why

editorial-voice 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 3d 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/editorial-voice.mdc · 56 lines

How it starts

The opening of the file, as written. The whole thing — 56 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Editorial voice

This repository follows the Consensys documentation style guide. The rules below are the most actionable subset for AI-assisted editing.

Headings

  • Use sentence case for all headings and bullet points (for example, "Key benefits", not "Key Benefits").
  • Use imperative tense for headings (for example, "Configure a node", not "Configuring a node" or "How to configure a node"). Keep headings as concise as possible.

Voice and clarity

  • Write in active voice. Prefer short, direct sentences: if a sentence needs a second read, rewrite it.
  • Define jargon on first use, on every page it appears (for example: prover, coordinator, base fee, blob). Don't assume a term defined on one tab carries over to another.
  • No filler or promotional language (for example, "Linea is excited to announce..."). Get to the point.
  • Prefer evergreen wording on concept and reference pages. Avoid date-specific claims unless explicitly scoped (for example, "as of March 2026"). Release-specific detail, rollout phases, and operational notes belong in docs/changelog, not on concept pages.
  • Don't write in first person ("I", "we'll", "let's", "our contract"), with one exception: "we recommend" is allowed when giving guidance. Default to second person and imperative instructions instead ("Create a file...", "Run...").
  • No emojis, decorative or otherwise, and no hype or sign-off language ("Happy building!", "Let's dive in!").

Punctuation

  • Don't use em dashes or en dashes. Use a comma, colon, parenthesis, semicolon, or rephrase the sentence into two.
  • Use only one space after a period, question mark, or colon.

Marking unverified information

If you're documenting a number, address, version, or date you can't verify against source code, a spec, or another authoritative reference, mark it inline with [VERIFY] rather than guessing or omitting it silently. Flag any [VERIFY] markers in your pull request description so reviewers know what still needs confirmation before merge.

Read the full file on GitHub · 56 lines

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. 3d ago First seen · 56 lines · 0 tokens per session scan A b10dfa81fcfb

Subscribe to this mod's changes

editorial-voice is a cursor rule published in the GitHub repository Consensys/doc.linea (474 stars, last pushed 6d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 564 tokens. 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.