What is AgentEval docfx.instructions.md?

A set of instructions for DocFX, a tool that turns .NET source code and Markdown files into a documentation website, in the AgentEval project. It describes the documentation folders, configuration, templates, and build process.

Use it when editing AgentEval docs, changing DocFX settings, generating API metadata, or building the documentation website.

It gives contributors a consistent way to generate API reference pages and the rest of the documentation site. This avoids configuration mistakes and unclear build steps.

AgentEval docfx.instructions.md — Instructions file by AgentEvalHQ

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/agentevalhq/agenteval/docfx

Clone the repo

git clone --depth 1 https://github.com/AgentEvalHQ/AgentEval

Made for: GitHub Copilot.

Per session 1,112 This file is loaded in full into every session.

When invoked 1,112 The same file — it is already loaded in full.

Security scan B 1 finding. 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.

Model	Per session	Once invoked
Fable 5	$0.01112	$0.01112
Opus 5	$0.00556	$0.00556
Sonnet 5	$0.00222	$0.00222
Haiku 4.5	$0.00111	$0.00111

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

Security

Grade B, and why

AgentEval docfx.instructions.md scanned grade B with 1 finding 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.

Strips warnings and disclaimersmediumAnti-refusal

Omitting safety caveats hides risk from the user and is a common jailbreak preamble.

- [ ] `docfx build` completes without warnings

.github/instructions/docfx.instructions.md · 173 lines

How it starts

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

DocFX Instructions for AgentEval

Instructions for working with DocFX documentation generation in AgentEval

Project Setup

File Structure

docs/
├── docfx.json          # Main configuration
├── toc.yml             # Navigation structure
├── index.md            # Landing page
├── api/                # Generated API YAML (git-ignored for *.yml)
├── _site/              # Generated HTML output (git-ignored)
├── images/             # Static images
├── templates/          # Custom templates (material theme)
├── adr/                # Architecture Decision Records
└── showcase/           # Code gallery and examples

Key Configuration (docfx.json)

{
  "metadata": [{
    "src": [{ "src": "../src", "files": ["**/*.csproj"] }],
    "dest": "api",
    "properties": { "TargetFramework": "net10.0" }
  }],
  "build": {
    "template": ["default", "modern", "templates/material"],
    "output": "_site"
  }
}

Build Commands

Full Build (Recommended)

# From repository root
.\scripts\build-documentation.ps1

Step-by-Step

# 1. Build project (generates XML docs)
dotnet build src\AgentEval\AgentEval.csproj --configuration Release

# 2. Generate API metadata (YAML files)
cd docs
docfx metadata

# 3. Build HTML site
docfx build

# 4. Preview locally
docfx serve _site
# Opens at http://localhost:8080

Quick Rebuild (Markdown only)

# Skip metadata regeneration if only editing .md files
cd docs
docfx build
start _site\index.html

Common Issues & Solutions

Issue: API docs not generating

Cause: XML documentation disabled in csproj Fix: Ensure <GenerateDocumentationFile>true</GenerateDocumentationFile> in csproj

Issue: docfx metadata fails

Cause: Build errors in source code Fix: Run dotnet build first and fix any compilation errors

Issue: Changes not appearing

Cause: Browser cache or stale _site folder Fix:

Remove-Item -Recurse -Force docs\_site
docfx build

Read the full file on GitHub · 173 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.

3d ago First seen · 173 lines · 1,112 tokens per session scan B aff3e7289b55

Subscribe to this mod's changes

AgentEval docfx.instructions.md is an instructions file published in the GitHub repository AgentEvalHQ/AgentEval (138 stars, last pushed 3d ago), licensed MIT. It adds 1,112 tokens to every session, about $0.0056 per session on Opus 5. A static security scan graded it B with 1 finding (strips warnings and disclaimers). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Writing and docs agent agentic evals evaluations framework net

AgentEval docfx.instructions.md