docs

A documentation workflow for keeping the project's docs/ folder up to date as features change. It treats those documents as the main explanation of how the software works.

In plain words
What is it for?
Use it to create or update feature explainers, document interfaces and configuration, describe how systems work, and record references.
Why use it?
It reduces the chance that documentation becomes outdated after a major feature is added, changed, or removed.

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

Made for: Claude Code, Codex.

Per session 47 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 569 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.00047 $0.00569
Opus 5 $0.00023 $0.00284
Sonnet 5 $0.00009 $0.00114
Haiku 4.5 $0.00005 $0.00057

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

Security

Grade A, and why

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 2d 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.

.claude/skills/docs/SKILL.md · 55 lines

How it starts

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

Documentation Skill

You maintain the docs/ directory as the source of truth for how Opal works. Each major feature or subsystem gets an evergreen explainer that stays current as the code changes.

When to act

  • A feature is added, significantly changed, or removed → update or create the relevant doc.
  • The user explicitly asks to document something.
  • A pull request changes behavior described in an existing doc.

Format guidelines

Write docs that are right-sized — long enough to be useful, short enough to actually be read.

  • Start with a one-paragraph overview of what the feature does and why it exists.
  • Show the interface (tool schema, function signature, config keys) before explaining internals.
  • Use Mermaid diagrams for pipelines, data flow, and architecture — never ASCII art. Wrap in ```mermaid fenced blocks.
  • Include a "How it works" section with just enough detail to debug or extend the feature. Skip implementation trivia.
  • End with a References section linking to external sources, blog posts, papers, or benchmarks that informed the design. Always include references the user has provided.
  • No timestamps or version numbers — the doc describes the current state, not a changelog.

File organization

docs/
├── ARCHITECTURE.md       # System-level overview
├── tools/
│   ├── edit.md           # Edit tool (hashline, str_replace history)
│   └── ...               # One file per major tool or tool concept
├── agent-loop.md         # Agent execution model
├── compaction.md         # Context compaction
├── supervision.md        # OTP supervision tree
└── ...                   # One file per subsystem

Place tool docs in docs/tools/. Place subsystem docs directly in docs/.

Style

  • Write for a developer who knows the language but not the codebase.
  • Prefer concrete examples over abstract descriptions.
  • Use code blocks for schemas, configs, and short snippets.
  • Keep headings to 3 levels max (##, ###, no ####).
  • Link to source files when referencing specific modules (e.g. lib/opal/tool/edit_lines.ex).

Read the full file on GitHub · 55 lines

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. 2d ago First seen · 55 lines · 47 tokens per session scan A cf7022b1742e

Subscribe to this mod's changes

docs is a skill published in the GitHub repository matteing/opal (58 stars, last pushed 20d ago), licensed MIT. It adds 47 tokens to every session and 569 once invoked, about $0.0002 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

agent-pattern-verification

Verify AI agent code for dangerous patterns including infinite loops, unbounded retries, tool hallucinations, and context overflow. Use before deploying agent workflows or when reviewing agent code.

aryaminus/controlkeel · 39 tokens

cloudflare-agent

Enable ControlKeel governance for Cloudflare Agents with policy gates, budget enforcement, PII detection, and secure execution.

aryaminus/controlkeel · 28 tokens

controlkeel-governance

Operate inside a ControlKeel-governed session. Use this before code edits, shell execution, delegation, deploy work, or any task that needs CK validation, findings, budget, proof, or routing context.

aryaminus/controlkeel · 50 tokens

bounded-loop

Run objective, repeatable improvement work under an immutable verifier and hard iteration, cost, time, and no-progress limits. Use for approved experiments with an automated metric and sandboxed worker.

aryaminus/controlkeel · 40 tokens

challenge

Adversarially challenge the current plan or finding. Assume the direction is wrong and build the strongest case against it. Surfaces blind spots, false assumptions, and unexplored alternatives before execution starts.

aryaminus/controlkeel · 42 tokens

continuity

Learn, record, audit, and apply codebase patterns consistently across a repo by comparing current code to canonical local examples stored in CK memory. Use when asked to preserve continuity, learn a pattern, check drift, fix inconsistent implementations, or enforce local conventions.

aryaminus/controlkeel · 54 tokens