Agent skill

Writing Docs

by nukeop in nukeop/nuclear

A skill your agent uses when writing or editing documentation in packages/docs.

AGPL-3.0Auto-check passedWriting & Content

Install Writing Docs

skills CLI
$ npx skills add nukeop/nuclear --skill writing-docs -a claude-code

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

GitHub CLI
$ gh skill install nukeop/nuclear writing-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/nukeop/nuclear.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/writing-docs .claude/skills/writing-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
writing-docs
GitHub stars
19k
Token cost
~907 tokens
SKILL.md length
212 words
Files
1
Skills in repo
5
Repo updated
First seen
Licence
AGPL-3.0

At a glance

A skill your agent uses when writing or editing documentation in packages/docs.

  • Editing documentation in packages/docs
  • SKILL.md covers Page structure, Table of contents, Gitbook special blocks and Content guidelines
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Phrases include write docs

What it does

Writing Docs is an agent skill from nukeop/nuclear. Use when writing or editing documentation in packages/docs. Covers Gitbook markdown syntax, special blocks, page structure, and the SUMMARY.md table of contents. Trigger phrases include "write docs", "add documentation", "docs page", "gitbook", "user manual".

Its SKILL.md is about 910 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 Writing & Content, covering Technical writing. It works with Model Context Protocol. The repository describes itself as: Streaming music player that finds free music for you. The licence is AGPL-3.0.

When your agent uses it

  • Editing documentation in packages/docs
  • Phrases include write docs
  • Add documentation

Example prompts

  • “write docs”
  • “add documentation”
  • “docs page”
  • “/writing-docs”

What it can do on your machine

Read from SKILL.md and the folder at commit 27904e9. 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 (its code samples are markdown).

    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

Writing Docs loads about 907 tokens when it runs. Until then it costs about 68 tokens; SKILL.md has 212 words of instructions outside code blocks.

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

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

The full file from nukeop/nuclear at commit 27904e9, republished under its AGPL-3.0 licence (© nukeop). 212 words, ~907 tokens.

Download SKILL.mdSave it as .claude/skills/writing-docs/SKILL.md (or your agent's skills folder).
name
writing-docs
description
Use when writing or editing documentation in packages/docs. Covers Gitbook markdown syntax, special blocks, page structure, and the SUMMARY.md table of contents. Trigger phrases include "write docs", "add documentation", "docs page", "gitbook", "user manual".

Writing Documentation

Docs live in packages/docs/. Hosted on Gitbook, synced from the repo via .gitbook.yaml.

Page structure

Every page starts with YAML frontmatter and a top-level heading:

markdown
---
description: Short description shown in search and link previews
---

# Page title

Table of contents

packages/docs/SUMMARY.md defines the sidebar navigation. Group pages under ## headings:

markdown
# Table of contents

* [Nuclear Documentation](README.md)

## User Manual

* [Getting started](user-manual/getting-started.md)
* [Installation](user-manual/installation.md)

## Plugins

* [Getting started](plugins/getting-started.md)

When adding a new page, always add it to SUMMARY.md or it won't appear in the sidebar.

Gitbook special blocks

Tabs

Use for platform-specific instructions or language variants:

markdown
{% tabs %}

{% tab title="Windows" %}
Content for Windows.
{% endtab %}

{% tab title="macOS" %}
Content for macOS.
{% endtab %}

{% tab title="Linux" %}
Content for Linux.
{% endtab %}

{% endtabs %}

Tabs can contain any block type (code, tables, lists, images) but cannot nest other tabs or expandables.

Hints (callouts)

Four styles: info, success, warning, danger.

markdown
{% hint style="info" %}
General information or tips.
{% endhint %}

{% hint style="warning" %}
Non-critical warnings or gotchas.
{% endhint %}

{% hint style="danger" %}
Destructive actions or critical information.
{% endhint %}

{% hint style="success" %}
Positive actions or confirmations.
{% endhint %}
Code blocks with options

Wrap in {% code %} for title, line numbers, or wrapping:

markdown
{% code title="config.json" overflow="wrap" lineNumbers="true" %}

```json
{
  "key": "value"
}
```

{% endcode %}

Without the wrapper, standard fenced code blocks work fine.

Expandable (collapsible sections)

Uses standard HTML <details> / <summary>:

markdown
<details>

<summary>Click to expand</summary>

Hidden content goes here. Supports lists and code blocks.

</details>

Add open attribute to expand by default: <details open>.

Prominent block-level links to other pages:

markdown
{% content-ref url="getting-started.md" %}
[Getting started](getting-started.md)
{% endcontent-ref %}
Cards

Grid layout for landing pages. Uses a table with data-view="cards":

markdown
<table data-view="cards">
  <thead>
    <tr>
      <th></th>
      <th></th>
      <th data-hidden data-card-target data-type="content-ref"></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><strong>Card title</strong></td>
      <td>Card description.</td>
      <td><a href="page.md">page.md</a></td>
    </tr>
  </tbody>
</table>
Annotations (footnotes)
markdown
Nuclear uses plugins[^1] to provide functionality.

[^1]: Plugins are installed from the plugin store.

Content guidelines

  • No brand names of third-party services in docs
  • All user-facing strings reference i18n keys, not hardcoded text
  • Use relative links between docs pages (../themes/themes.md), not absolute URLs
  • Keep pages focused on one topic. Link to related pages instead of duplicating content.
  • Describe the UI as the user sees it: use actual button labels, menu names, and icon descriptions

© nukeop, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/writing-docs of nukeop/nuclear.

Open the folder on GitHubat commit 27904e9

Compare with similar skills

Writing 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.

Writing Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Writing Docs this skillnukeop/nuclear19k—~907Automated safety check: PassAGPL-3.0
Nemoclaw User GuideNVIDIA/NemoClaw23k—~869Automated safety check: PassApache-2.0
Product Helpopen-octo/octo-agent125—~1.4kAutomated safety check: PassMIT
Agentdock User Guideuvwt/agentdock1.2k—~1.6kAutomated safety check: PassApache-2.0
Nemoclaw User GuideNVIDIA/skills3.5k—~1.2kAutomated safety check: PassApache-2.0
JavaScript Concept Fact Checkerleonardomso/33-js-concepts67k1 repos~5kAutomated safety check: PassMIT

Similar skills

  • Nemoclaw User Guide

    NVIDIA/NemoClaw

    Official

    Find official NemoClaw documentation for installation, configuration, operation, or troubleshooting.

    23k GitHub stars~869 tokensUpdated today
    Writing & ContentAuto-check passed
  • Product Help

    open-octo/octo-agent

    Answer questions about how to use octo, or diagnose something that isn't working, by reading the product documentation.

    125 GitHub stars~1.4k tokensUpdated 2 days ago
    Writing & ContentAuto-check passed
  • Agentdock User Guide

    uvwt/agentdock

    当用户询问 AgentDock 是什么、如何使用、配置在哪里、不同平台或安装方式怎样修改配置并生效、如何重启或验证配置、如何发现并配置 Codex/Claude/Grok 等 Coding Agent 的 ACP,以及常见运行问题时使用;覆盖 macOS Desktop、Windows Desktop、Linux 服务、Docker 和直接运行二进制,不用于源码开发与贡献流程。

    1.2k GitHub stars~1.6k tokensUpdated today
    DevOps & CloudAuto-check passed
  • Nemoclaw User Guide

    NVIDIA/skills

    Official

    Guides human users' AI agents to the NemoClaw docs MCP server and canonical Fern documentation in Markdown form.

    3.5k GitHub stars~1.2k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • JavaScript Concept Fact Checker

    leonardomso/33-js-concepts

    Verifies the technical accuracy of JavaScript concept pages by checking code examples, MDN and ECMAScript claims and external links through a five-phase method.

    67k GitHub starsUsed in 1 repo~5k tokens
    Writing & ContentAuto-check passed
  • Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.

    28k GitHub stars~3.2k tokensUpdated today
    Writing & ContentAuto-check passed

More from nukeop/nuclear

  • Making Demo Videos

    nukeop/nuclear

    A skill your agent uses when making a demo, tutorial, or feature video of Nuclear.

    19k GitHub stars~892 tokensUpdated yesterday
    Auto-check passed
  • Creating Components

    nukeop/nuclear

    A skill your agent uses when creating new UI components in packages/ui.

    19k GitHub stars~1k tokensUpdated yesterday
    Auto-check passed
  • Host Pattern

    nukeop/nuclear

    A skill your agent uses when adding a new domain to Nuclear's plugin system, or implementing a host.

    19k GitHub stars~1.3k tokensUpdated yesterday
    Auto-check passed
  • Writing Plugins

    nukeop/nuclear

    A skill your agent uses when writing, scaffolding, or modifying Nuclear plugins.

    19k GitHub stars~825 tokensUpdated yesterday
    Auto-check passed

Questions about Writing Docs

What does Writing Docs do?

A skill your agent uses when writing or editing documentation in packages/docs. Writing Docs is an agent skill from nukeop/nuclear. Use when writing or editing documentation in packages/docs.

When should I use Writing Docs?

Writing Docs fits situations like: editing documentation in packages/docs; phrases include write docs; add documentation.

How do I install Writing Docs in Claude Code?

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

How do I install Writing Docs in Codex?

Run `npx skills add nukeop/nuclear --skill writing-docs -a codex`. Or copy the skill folder (.agents/skills/writing-docs in nukeop/nuclear) into .agents/skills/writing-docs in your project. Codex loads it when a task matches its description.

Can I use Writing 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 nukeop/nuclear --skill writing-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/writing-docs, .gemini/skills/writing-docs, .github/skills/writing-docs and .opencode/skills/writing-docs in your project.

What does Writing Docs need to run?

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

Does Writing 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 Writing 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 Writing Docs use?

Writing Docs is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Writing Docs use?

About 907 tokens (SKILL.md is roughly 3.6k 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 Writing Docs?

Skills that share tags, products or a category with Writing Docs: Nemoclaw User Guide (NVIDIA/NemoClaw, 23k stars), Product Help (open-octo/octo-agent, 125 stars), Agentdock User Guide (uvwt/agentdock, 1.2k stars) and Nemoclaw User Guide (NVIDIA/skills, 3.5k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Writing Docs?

nukeop (a GitHub user) maintains it in nukeop/nuclear, which has 18,611 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on October 6, 2026.

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