Agent skill

Write Docs

by usetrmnl in usetrmnl/trmnl-framework

House style for TRMNL framework documentation copy. An agent skill from usetrmnl/trmnl-framework.

Custom licenceAuto-check passedFrontend & Design

Install Write Docs

skills CLI
$ npx skills add usetrmnl/trmnl-framework --skill write-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install usetrmnl/trmnl-framework write-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/usetrmnl/trmnl-framework.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/write-docs .claude/skills/write-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
write-docs
GitHub stars
118
Token cost
~2.5k tokens
SKILL.md length
1,491 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
Custom licence

At a glance

House style for TRMNL framework documentation copy. An agent skill from usetrmnl/trmnl-framework.

  • Editing docs pages (app/views/framework/.html.erb)
  • SKILL.md covers Match the neighbors, Voice, Plain words first and Earn the paragraph, plus 6 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Intro paragraphs in frameworkhelper.rb

What it does

Write Docs is an agent skill from usetrmnl/trmnl-framework. House style for TRMNL framework documentation copy. Use whenever writing or editing docs pages (app/views/framework/.html.erb), intro paragraphs in frameworkhelper.rb, code example captions, or notice boxes.

Its SKILL.md is about 2.5k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Frontend & Design. The repository describes itself as: TRMNL ePaper design system.

When your agent uses it

  • Editing docs pages (app/views/framework/.html.erb)
  • Intro paragraphs in frameworkhelper.rb
  • Code example captions

Example prompts

  • “/write-docs”

What it can do on your machine

Read from SKILL.md and the folder at commit 0f3fb5a. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Write Docs loads about 2.5k tokens when it runs. Until then it costs about 55 tokens; SKILL.md has 1,491 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~55
When it runs · the whole SKILL.md, loaded when a task matches
~2.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,491 words (~2,459 tokens).

“The docs read like a calm engineer explaining a tool: plain, concrete, and short. Every section earns its length. The reference corpus is the intro paragraphs in app/helpers/framework_helper.rb and mature pages like background.html.erb, divider.html.erb, and columns.html.erb.”

— opening of SKILL.md by usetrmnl, Custom licence
name
write-docs

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .claude/skills/write-docs of usetrmnl/trmnl-framework.

Open the folder on GitHubat commit 0f3fb5a

Compare with similar skills

Write Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Write Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Write Docs this skillusetrmnl/trmnl-framework118—~2.5kAutomated safety check: PassCustom licence
React Doctormakeplane/plane61k12 repos~657Automated safety check: PassAGPL-3.0
React Router Developmentremix-run/react-router57k1 repos~1.5kAutomated safety check: PassMIT
React UI State PatternsChrisWiles/claude-code-showcase6.1k8 repos~1.6kAutomated safety check: PassNone
Vercel React Best Practicessanity-io/sanity6.4k129 repos~1.6kAutomated safety check: PassMIT
Scraps Reviewgetsentry/sentry46k—~1.2kAutomated safety check: NotesCustom licence

Similar skills

  • React Doctor

    makeplane/plane

    Scans React code for lint, accessibility, bundle size and architecture issues, reports a health score and checks that changes do not lower it.

    61k GitHub starsUsed in 12 repos~657 tokens
    Frontend & DesignAuto-check passed
  • React Router Development

    remix-run/react-router

    Guides work on React Router apps by first identifying whether the app uses Framework, Data or Declarative mode, then loading the matching reference and the installed package docs.

    57k GitHub starsUsed in 1 repo~1.5k tokens
    Frontend & DesignAuto-check passed
  • React UI State Patterns

    ChrisWiles/claude-code-showcase

    Sets patterns for React interfaces: when to show loading spinners or skeletons, how to surface errors, how to disable buttons during async work and how to handle empty lists.

    6.1k GitHub starsUsed in 8 repos~1.6k tokens
    Frontend & DesignAuto-check passed
  • Official

    React and Next.js performance optimization guidelines from Vercel Engineering.

    6.4k GitHub starsUsed in 129 repos~1.6k tokens
    Frontend & DesignAuto-check passed
  • Scraps Review

    getsentry/sentry

    Official

    Filter large Sentry Scraps design-system migration PRs for review by separating mechanical import-path changes, generated baseline updates, snapshot mocks, and pure renames from substantive…

    46k GitHub stars~1.2k tokensUpdated yesterday
    Frontend & DesignAuto-check: notes
  • Frontend Module Standards

    siteboon/claudecodeui

    Enforces one repository's React and TypeScript module layout for code under src/: source-root imports, feature barrels, deliberate exports and no deep imports.

    14k GitHub stars~2.6k tokensUpdated yesterday
    Frontend & DesignAuto-check passed

Questions about Write Docs

What does Write Docs do?

House style for TRMNL framework documentation copy. An agent skill from usetrmnl/trmnl-framework. Write Docs is an agent skill from usetrmnl/trmnl-framework. House style for TRMNL framework documentation copy.

When should I use Write Docs?

Write Docs fits situations like: editing docs pages (app/views/framework/.html.erb); intro paragraphs in frameworkhelper.rb; code example captions.

How do I install Write Docs in Claude Code?

Run `npx skills add usetrmnl/trmnl-framework --skill write-docs -a claude-code`. Or copy the skill folder (.claude/skills/write-docs in usetrmnl/trmnl-framework) into .claude/skills/write-docs in your project. Claude Code loads it when a task matches its description.

How do I install Write Docs in Codex?

Run `npx skills add usetrmnl/trmnl-framework --skill write-docs -a codex`. Or copy the skill folder (.claude/skills/write-docs in usetrmnl/trmnl-framework) into .agents/skills/write-docs in your project. Codex loads it when a task matches its description.

Can I use Write Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add usetrmnl/trmnl-framework --skill write-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-docs, .gemini/skills/write-docs, .github/skills/write-docs and .opencode/skills/write-docs in your project.

What does Write Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: Write Docs is instructions for the agent only.

Does Write Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Write Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Write Docs use?

Write Docs has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Write Docs use?

About 2.5k tokens (SKILL.md is roughly 9.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Write Docs?

Skills that share tags, products or a category with Write Docs: React Doctor (makeplane/plane, 61k stars), React Router Development (remix-run/react-router, 57k stars), React UI State Patterns (ChrisWiles/claude-code-showcase, 6.1k stars) and Vercel React Best Practices (sanity-io/sanity, 6.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Write Docs?

usetrmnl (a GitHub organization) maintains it in usetrmnl/trmnl-framework, which has 118 GitHub stars. The repository was last updated on October 9, 2026.

Source: usetrmnl/trmnl-framework on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.