document-design-system AGENTS.md

Repository instructions for a document design system: a set of rules for organizing documents and applying visual themes. They cover matching Markdown examples, HTML templates, scripts, and tests.

In plain words
What is it for?
Use them when editing document types, choosing a reading structure or theme, rebuilding examples, regenerating screenshots, and running validation.
Why use it?
They keep written examples and generated document designs consistent when the repository changes.

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/avinava/document-design-system/agents-md
Clone the repo
git clone --depth 1 https://github.com/Avinava/document-design-system

Made for: Codex, OpenCode.

Per session 347 This file is loaded in full into every session.
When invoked 347 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.00347 $0.00347
Opus 5 $0.00173 $0.00173
Sonnet 5 $0.00069 $0.00069
Haiku 4.5 $0.00035 $0.00035

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

Security

Grade A, and why

document-design-system 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 yesterday.

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 · 37 lines

What it actually says

Repository guidance

This repository treats document design as two independent axes:

  • Document pattern controls reading structure and is declared with data-pattern.
  • Theme controls visual voice through semantic tokens and is declared with data-theme.

Do not reduce the writing examples to one generic longform layout. Select one of the eight patterns in core/document-patterns.md, then use the modules that support that reader movement. Keep prose readable at 62–72 characters while allowing maps, tables, comparisons, timelines, and registers to use the wider shell.

Markdown in examples/<slug>.md is the canonical repository-friendly form. Designed HTML is generated from templates/types/<slug>.html; both must use the same title and factual anchors from examples/WORLD.md.

When changing a writing-document type:

  1. Keep its pattern and default-theme fields aligned with scripts/build_examples.py.
  2. Update both Markdown and HTML examples.
  3. Rebuild with python3 scripts/build_examples.py.
  4. Regenerate relevant screenshots with python3 scripts/shoot_examples.py.
  5. Run python3 -m unittest discover -s tests -v, python3 scripts/validate_repository.py ., and python3 scripts/build_site.py --check.

GitHub Pages is source-built. Do not hand-edit site/; the workflow rebuilds examples before assembling the deployable site.

Do not add source-provenance, copied product naming, or private reference links to repository documents, examples, screenshots, commit messages, or release notes. Express the design principle in this repository's own vocabulary.

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. yesterday First seen · 37 lines · 347 tokens per session scan A d1bb68cd6800

Subscribe to this mod's changes

document-design-system AGENTS.md is an instructions file published in the GitHub repository Avinava/document-design-system (2 stars, last pushed 7d ago), licensed MIT. It adds 347 tokens to every session, about $0.0017 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-31.