docsector-documentation-authoring

A writing guide for creating Docsector documentation pages in Markdown, including its custom page elements and content structures. Docsector is a system for publishing documentation that can be read by people and AI agents.

In plain words
What is it for?
Use it to write or edit guides, API references, release notes, landing pages, examples, and troubleshooting pages. It also helps document Docsector’s authoring syntax for another AI assistant.
Why use it?
It helps you choose the right page structure and formatting instead of guessing how Docsector content should be written. It also points to current Docsector documentation when connected sources are available.

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/docsector/docsector-reader/docsector-documentation-authoring
Any agent
npx skills add docsector/docsector-reader --skill docsector-documentation-authoring
Clone the repo
git clone --depth 1 https://github.com/docsector/docsector-reader

Made for: Claude Code, Codex.

Per session 65 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,314 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.00065 $0.01314
Opus 5 $0.00032 $0.00657
Sonnet 5 $0.00013 $0.00263
Haiku 4.5 $0.00006 $0.00131

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

Security

Grade A, and why

docsector-documentation-authoring 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.

.github/skills/docsector-documentation-authoring/SKILL.md · 119 lines

How it starts

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

Docsector Documentation Authoring

When to Use

Use this skill when creating, reviewing, or editing documentation for a site built with Docsector Reader.

Use it for:

  • Choosing the right Docsector block for a content need.
  • Writing Markdown pages with Docsector custom elements.
  • Creating overview, showcase, guide, API reference, changelog, or landing content.
  • Finding live Docsector docs through MCP, WebMCP, Markdown negotiation, or llms.txt.
  • Teaching an AI assistant how Docsector pages, blocks, and examples are authored.

Expected Outcome

  • The page uses standard Markdown where Markdown is enough.
  • Rich interactions use the appropriate Docsector custom element.
  • Links, assets, examples, and API JSON use Docsector conventions.
  • The result is easy to scan, accessible, and friendly to both humans and agents.
  • When MCP or WebMCP is available, current Docsector documentation is queried instead of relying only on memory.

Authoring Workflow

  1. Identify the page purpose: concept, tutorial, API reference, release note, navigation hub, example showcase, or troubleshooting guide.
  2. Use headings to shape the reading path. In normal page content, start with ## because the page title is supplied by metadata — the registry entry, or an optional title: in the page's own frontmatter block.
  3. Pick the simplest block that communicates the content. Prefer Markdown first, then Docsector custom elements when the layout or interaction needs it.
  4. Keep custom element attributes short and explicit. Use to for internal navigation and href for external URLs.
  5. Put reusable assets in stable public paths such as /images/..., /files/..., /api/..., or /quasar-api/....
  6. For live examples, place Vue SFCs under src/examples/**/*.vue and reference them with <d-block-code-example>.
  7. For API references, serve JSON from a same-origin public asset and reference it with <d-block-api>.
  8. Validate links, anchors, code fences, and custom element closing tags before finishing.

Read the full file on GitHub · 119 lines

Files

What ships with it

4 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. 3d ago First seen · 119 lines · 65 tokens per session scan A 29bdc2cf9ff1

Subscribe to this mod's changes

docsector-documentation-authoring is a skill published in the GitHub repository docsector/docsector-reader (21 stars, last pushed 1mo ago), licensed MIT. It adds 65 tokens to every session and 1,314 once invoked, about $0.0003 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

golden-rss

Use when testing the rss golden build.

yusufkaraaslan/Skill_Seekers · 12 tokens

golden-chat-single

Use when testing the goldenchatsingle golden build.

yusufkaraaslan/Skill_Seekers · 14 tokens

dev-pain-finder

Scrape real developer pain points for any keyword, technology, or problem space from Reddit, Hacker News, dev.to, and GitHub Discussions simultaneously — then group complaints by theme, score them by frequency and upvote weight, and return a ranked opportunity map showing where developer frustration is high and…

tinyfish-io/tinyfish-cookbook · 160 tokens

decided-import

Reformat ONE existing document (a decision, requirement, design, roadmap, or prompt) into ONE valid RAC (requirements-as-code) artifact, with a mandatory human-review step before any file is written and decided validate as the deterministic close. Use when a user wants to add or import a single existing decision or…

asdecided/core · 98 tokens

plan-a-feature-to-confluence

Builds a feature specification from scratch with plan-a-feature and publishes it to a user-specified Confluence location, posting the spec as a parent page and each companion artifact (decision log, team findings, technical notes) as a child page beneath it. Use when the user wants a new feature planned, designed…

testdouble/han · 154 tokens

keep-the-why

Preserves or recovers the reasoning behind a codebase - architectural decisions, rejected alternatives, workarounds, incident learnings, operational constraints, and historical context the code itself cannot explain. Use when implementing or reviewing a non-trivial change involving a design decision, workaround…

oliver-zehentleitner/keep-the-why · 163 tokens