docs AGENTS.md

Repository instructions for a documentation website built with Hugo, a tool that turns source content into static web pages, using the PatternFly design theme. Its content uses Markdown and AsciiDoc, a text format for structured technical documentation.

In plain words
What is it for?
Use them when creating or reviewing blog posts, learning pages, patterns, contribution guides, templates, shortcodes, or documentation modules.
Why use it?
They map the site’s folders and require the project’s documentation-specific skills, reducing the chance of editing the wrong files or theme.

Instructions file for CodexOpenCode

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 instructions/validatedpatterns/docs/agents-md
Clone the repo
git clone --depth 1 https://github.com/validatedpatterns/docs

Made for: Codex, OpenCode.

Per session 2,421 This file is loaded in full into every session.
When invoked 2,421 The same file — it is already loaded in full.
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.02421 $0.02421
Opus 5 $0.01210 $0.01210
Sonnet 5 $0.00484 $0.00484
Haiku 4.5 $0.00242 $0.00242

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

Security

Grade A, and why

docs AGENTS.md 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.

AGENTS.md · 235 lines

How it starts

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

AGENTS.md

This file helps AI agents understand the structure, tooling, and conventions of the Validated Patterns documentation repository so they can make correct, buildable changes. For creating or reviewing documentation content, use the skills under .rulesync/skills/ (see AI documentation skills).

Project Overview

This is the documentation site for validatedpatterns.io, built with Hugo (static site generator) and the PatternFly theme. Content is authored in both AsciiDoc (rendered by Asciidoctor with Rouge syntax highlighting) and Markdown (rendered by Goldmark). There is no JavaScript framework, no TypeScript, and no package.json at the repository root.

Repository Layout

content/          Site content organized by section (blog/, ci/, contribute/, learn/, patterns/, search/)
modules/          Reusable AsciiDoc modules and pattern metadata (included via include::)
layouts/          Hugo templates, partials (layouts/partials/), and shortcodes (layouts/shortcodes/)
archetypes/       Hugo content scaffolds for new pages (blog, learn, contribute, pattern)
themes/patternfly/  Vendored PatternFly theme — do NOT edit
static/           Static assets (CSS, JS, images, videos)
assets/           Hugo asset pipeline (images)
utils/            Ruby scripts (e.g. flatten_yaml.rb for pattern metadata)
.rulesync/skills/ AI agent skills for creating and reviewing documentation (source of truth)
config.yaml       Main Hugo configuration
Makefile          Build, serve, and test commands

AI documentation skills

This repository includes agent skills under .rulesync/skills/. These are the required workflows for creating and reviewing documentation. Do not free-form invent page structure, frontmatter, or style rules when these skills apply — read the skill file first and follow it precisely.

Skills may also be synced into editor-specific locations (for example .claude/skills/ or Cursor skills) via rulesync. Prefer the skill when it is available in the agent environment; if it is not loaded, read the source files under .rulesync/skills/ directly and execute the same workflow.

Read the full file on GitHub · 235 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 · 235 lines · 2,421 tokens per session scan A 5847f2c57d3c

Subscribe to this mod's changes

docs AGENTS.md is an instructions file published in the GitHub repository validatedpatterns/docs (20 stars, last pushed 7d ago), licensed Apache-2.0. It adds 2,421 tokens to every session, about $0.0121 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 instructions, from other repositories

Skill_Seekers CLAUDE.md

Instructions for yusufkaraaslan/Skill_Seekers, covering claude.md, project overview, essential commands, required before running tests or cli (src/ layout) and run all tests (never skip - all must pass before commits).

yusufkaraaslan/Skill_Seekers · 5,387 tokens

docs-to-pdf CLAUDE.md

Instructions for jean-humann/docs-to-pdf, covering claude development guide for docs-to-pdf, project overview, development environment setup, using mise (recommended) and install mise (if not already installed).

jean-humann/docs-to-pdf · 4,714 tokens

core copilot-instructions.md

Instructions for asdecided/core: These decisions are already accepted. Do not re-open or contradict them; ask the AsDecided MCP tools (getartifact, searchartifacts) for the full text before proposing a change that touches one.

asdecided/core · 3,534 tokens

backend.ai AGENTS.md

AGENTS.md instructions for lablup/backend.ai, covering ai coding agent guidelines, document structure (agents.md / knowledge.md), writing style, document index and absolute rules (global).

lablup/backend.ai · 1,864 tokens

alcove AGENTS.md

Instructions for epicsagas/alcove, covering claude.md, repository purpose, actual location, structure and karpathy 3-layer architecture.

epicsagas/alcove · 1,840 tokens

slideops CLAUDE.md

Instructions for glukicov/slideops, covering claude.md, what this repository is, commands, the demo deck's citations must still match this repo and the citation mechanism (the core idea).

glukicov/slideops · 1,321 tokens