writing-emdash-docs

A writing guide for EmDash technical documentation, including guides, API references, READMEs, migration notes, and release notes. It covers factual accuracy, organization, house style, and clear prose.

In plain words
What is it for?
Use it when writing, revising, or reviewing EmDash documentation and other technical pages covered by the project’s documentation practices.
Why use it?
It helps documentation stay accurate, consistent, useful, and understandable for its intended readers.

Skill for Claude CodeCodex

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 skills/emdash-cms/emdash/writing-emdash-docs
Any agent
npx skills add emdash-cms/emdash --skill writing-emdash-docs
Clone the repo
git clone --depth 1 https://github.com/emdash-cms/emdash

Made for: Claude Code, Codex.

Per session 85 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,486 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.00085 $0.01486
Opus 5 $0.00043 $0.00743
Sonnet 5 $0.00017 $0.00297
Haiku 4.5 $0.00009 $0.00149

Measured yesterday against content hash 7f90b5776f83, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

writing-emdash-docs 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 yesterday.

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.

skills/writing-emdash-docs/SKILL.md · 100 lines

How it starts

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

Writing EmDash docs

Produce documentation that helps a specific reader complete a task or understand a concrete part of EmDash. Treat factual accuracy, information design, and sentence-level style as separate checks.

Load the right context

Before drafting or editing:

  1. Read docs/src/content/docs/contributing/docs-style-guide.mdx completely for public documentation. Apply its relevant voice and readability rules to other prose in the repository.
  2. Read references/docs-practice.md completely for every writing or revision task.
  3. Read references/anti-slop.md completely for every writing or revision task.
  4. Read nearby pages of the same type to preserve established structure, terminology, frontmatter, imports, and Starlight component usage.
  5. Inspect the implementation, types, tests, command help, or configuration that establishes every technical claim. Do not rely on memory when the repository can answer the question.
  6. Read AGENTS.md for repository-wide rules.
  7. For changesets, read .changeset/README.md completely. Treat the entry as public CHANGELOG documentation and review whether affected readers can recognize the surface, understand the observable effect, and act on any migration guidance. Frontmatter validity and technical accuracy do not make an unhelpful entry acceptable.

Define the reader and outcome

State the intended outcome privately in one sentence: "After reading this, the reader can ..." Use it to decide what belongs on the page.

Classify the document before choosing its structure:

Document Reader need Default shape
Tutorial Learn through a reliable, guided experience Visible goal, prerequisites, one path, expected results after each stage, recap
Task guide Complete one practical task Outcome, prerequisites, ordered actions, result, optional next step
Concept or explanation Build an accurate mental model Definition, relevant behavior, concrete example, implications
Reference Look up exact behavior Signature or syntax, parameters, defaults, return value, errors, examples
Troubleshooting Diagnose and resolve a known failure Exact symptom, context, cause or diagnostic checks, workaround or resolution, verification
Upgrade or migration guide Make an existing project work after a change Previous behavior, current behavior, required action, minimal diff
README or contributor guide Start or contribute quickly Short purpose, fastest working path, common operations, deeper links
Technical specification Evaluate and implement a decision Goal, constraints, decision, interfaces and data flow, failure handling, rollout, verification, open decisions

Read the full file on GitHub · 100 lines

Files

What ships with it

3 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. yesterday First seen · 100 lines · 85 tokens per session scan A 7f90b5776f83

Subscribe to this mod's changes

writing-emdash-docs is a skill published in the GitHub repository emdash-cms/emdash (12,111 stars, last pushed 3d ago), licensed MIT. It adds 85 tokens to every session and 1,486 once invoked, about $0.0004 per session on Opus 5. 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.

Related

Other skills, from other repositories

wordpress-plugin-to-emdash

Port a WordPress plugin to EmDash CMS. Use this skill when asked to migrate, convert, or port a WordPress plugin, theme functionality, or custom post type to EmDash. Provides concept mapping and implementation patterns.

EngDawood/emdash-claude-plugin · 52 tokens

building-emdash-site

Build and customize EmDash CMS sites on Astro. Use when creating pages, defining collections, writing seed files, querying content, rendering Portable Text, setting up menus/taxonomies/widgets, configuring deployment, or any task involving an EmDash-powered Astro site. Assumes basic Astro knowledge but provides all…

EngDawood/emdash-claude-plugin · 70 tokens

emdash-cli

Use the EmDash CLI to manage content, schema, media, and more. Use this skill when you need to interact with a running EmDash instance from the command line — creating content, managing collections, uploading media, generating types, or scripting CMS operations.

EngDawood/emdash-claude-plugin · 56 tokens

emdash-github-actions

Sets up GitHub Actions CI/CD workflows for EmDash plugins — TypeScript type-checking, ESLint linting, Vitest testing, npm publishing, and automated releases. ALWAYS use this skill when a user wants to create, add, set up, or configure GitHub Actions, CI/CD, automated checks, or deployment workflows for an EmDash…

EngDawood/emdash-claude-plugin · 234 tokens

adversarial-reviewer

Adversarial code review that assumes bugs exist and hunts for them. Use when asked to review code, find bugs, audit for correctness, stress-test a PR, or when someone says "tear this apart" or "what's wrong with this". Give no benefit of the doubt — every line is guilty until proven innocent.

EngDawood/emdash-claude-plugin · 71 tokens

agent-browser

Browser automation for testing and verification. Use when you need to interact with web UIs, verify visual changes, fill forms, or capture screenshots.

EngDawood/emdash-claude-plugin · 32 tokens