agentleFS
ConsensysConsensys/doc.linea/.agents/skills/author-doc-page/SKILL.md

author-doc-page

Skill478 starsChanged 3 months agoApache-2.0View on GitHub

Scaffold or draft a new docs.linea.build page to editorial standards. Use when creating a new page, writing a first draft, or helping a contributor who isn't a professional writer produce content that meets the documentation team's expectations.

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Ask the user for anything they haven't already provided:

    line 25
  2. Very specific:

    Create the file with frontmatter (title, description.

    line 61
  3. Very specific:

    Use the correct casing for Linea/Lineth, components, and roles (terminology.mdc).

    line 73
  4. Distinctive:

    No marketing language or superlatives ("best-in-class", "powerful", "seamless").

    line 77
  5. Distinctive:

    After creating the page, remind the user to:

    line 95
  6. Very specific:

    Add an entry to redirects.json if any page was moved, renamed, or removed.

    line 97
  7. Very specific:

    Run npm run lint and npm run typecheck before opening a PR.

    line 99

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill 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
SKILL.md

Author a docs.linea.build page

Help create a new documentation page that follows docs.linea.build's editorial standards from the start.

When to use

  • You need to scaffold a new page or write a first draft.
  • You're helping a contributor who isn't a professional writer produce content that meets the documentation team's expectations (for example, an ecosystem partner documenting their integration).

Inputs

Ask the user for anything they haven't already provided:

  1. Tab: which tab is this for? (Linea Mainnet, Lineth Stack, Protocol, Reference, Changelog)
  2. Content type: concept/explanation, how-to guide, reference, or tutorial?
  3. Topic: what is the page about?
  4. File path: where should the file live? Suggest one based on the tab and topic if the user doesn't specify (see the directory table in README.mdx).
  5. Source material: what code, spec, PR, or other reference verifies the content?

Step 1: Confirm an issue exists, then load the relevant rules

Per .cursor/rules/contributor-workflow.mdc, an issue should exist for this change before work starts. Ask the user whether one's already open; if not, point them to CONTRIBUTING.md and the templates in .github/ISSUE_TEMPLATE/ so they can open one before you invest time scaffolding and drafting. This matters most for ecosystem/partner contributors.

Then read these rule files before scaffolding, and apply them by reference rather than restating them in the draft:

  • .cursor/rules/contributor-workflow.mdc: issue-first workflow, redirects, PR hygiene.
  • .cursor/rules/content-structure.mdc: tab, audience, tone, and page-structure conventions.
  • .cursor/rules/editorial-voice.mdc: voice, heading style, and the [VERIFY] marker convention.
  • .cursor/rules/terminology.mdc: casing, Linea vs. Lineth naming, and component capitalization.
  • .cursor/rules/markdown-formatting.mdc: frontmatter, links, and file conventions.

Also check how existing pages in the same folder are structured, and match their conventions for headings, frontmatter fields, and intro style.

Step 2: Scaffold the page

Create the file with frontmatter (title, description; no image, see markdown-formatting.mdc) and the structure from content-structure.mdc for the content type: an opening (no heading), then content sections, then verified code samples, then a resources section for links. How-to and tutorial pages use numbered steps with prerequisites listed first instead.

Step 3: Write the content

Fill in the scaffold with content based on what the user provides:

  • Identify the audience for this tab (content-structure.mdc) and write for it.
  • Define jargon on first use (editorial-voice.mdc).
  • Use the correct casing for Linea/Lineth, components, and roles (terminology.mdc). Check /protocol/linea-vs-lineth if you're unsure which product a claim belongs to.
  • Mark anything you can't verify with [VERIFY] rather than guessing.
  • No marketing language or superlatives ("best-in-class", "powerful", "seamless").

Step 4: Verify the page is complete

Before finishing, check:

  • Frontmatter has title and description, no manual image field.
  • Opening answers "what" and "why" in one to two sentences.
  • Structure matches the content type and neighboring pages.
  • Terminology and casing match terminology.mdc and the canonical /protocol/linea-vs-lineth page.
  • Any unverified values are marked [VERIFY].
  • Links are relative where possible, with no .mdx extension, and descriptive text.
  • Code samples have language tags and are placed near the bottom of the page.
  • File uses lowercase and dashes, and lives in the correct tab/content-type folder.

Step 5: Remind the contributor

After creating the page, remind the user to:

  1. Add an entry to redirects.json if any page was moved, renamed, or removed.
  2. Preview locally with npm run start.
  3. Run npm run lint and npm run typecheck before opening a PR.
  4. Link the issue from Step 1 in the pull request description (see CONTRIBUTING.md).

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.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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.