caracal: Instructions file for GitHub Copilot

.github/instructions/docs-documentation.instructions.md

caracal docs-documentation.instructions.md is an instructions file for GitHub Copilot from Garudex-Labs/caracal. It costs 400 tokens per session, scanned A, original, Apache-2.0.

Documentation rules for the Caracal documentation site, including its pages, navigation, components, styles, and public assets. They require changes to fit the surrounding documentation and remain limited to the affected area.

In plain words
What is it for?
Use them when writing or reviewing Caracal documentation, changing MDX pages, updating navigation, or modifying documentation components and assets.
Why use it?
They help keep technical pages consistent, complete, and easy to follow after an edit.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is Garudex-Labs/caracal's own configuration. It tells GitHub Copilot how to work on caracal itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything caracal configures →

Reuse

Borrowing it

Nothing to install: this file belongs to Garudex-Labs/caracal. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/Garudex-Labs/caracal/main/.github/instructions/docs-documentation.instructions.md
Clone the repo
git clone --depth 1 https://github.com/Garudex-Labs/caracal

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for caracal docs-documentation.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/garudex-labs/caracal/docs-documentation/github.svg)](https://agentmods.dev/instructions/garudex-labs/caracal/docs-documentation)
Your own site
<a href="https://agentmods.dev/instructions/garudex-labs/caracal/docs-documentation"><img src="https://agentmods.dev/badge/instructions/garudex-labs/caracal/docs-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for caracal docs-documentation.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/garudex-labs/caracal/docs-documentation"><img src="https://agentmods.dev/badge/instructions/garudex-labs/caracal/docs-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 400 This file is loaded in full into every session.
When invoked 400 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00400 $0.00400
Opus 5.5 $0.00160 $0.00160
Sonnet 5.5 $0.00080 $0.00080
Haiku 4.5 $0.00040 $0.00040

Measured 1mo ago against content hash 5a57a5d435ed, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

caracal docs-documentation.instructions.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 1mo 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/instructions/docs-documentation.instructions.md · 28 lines

What it actually says

Documentation Quality

  • Applies only to the Caracal documentation site under caracal/docs/, including MDX content, Astro and Starlight configuration, components, data, pages, styles, and public docs assets.

Required

  • Must treat all documentation as production-grade technical documentation for Caracal users, operators, contributors, and integrators.
  • Must understand the docs structure before editing, including astro.config.mjs sidebar order, src/content/docs/ page groups, shared components, generated pages, data files, styles, and public assets affected by the change.
  • Must preserve the flow, tone, audience, and purpose of each page.
  • Must edit the complete affected page or section coherently when updates are needed.
  • Must keep titles, descriptions, headings, links, examples, and cross-references consistent with the surrounding section and sidebar journey.
  • Must keep changes scoped to the affected pages, sections, navigation entries, components, data files, styles, and assets required for a coherent documentation update.
  • Must keep documentation professional, clear, structurally consistent, and naturally integrated.
  • Must use comments only when they explain documentation intent or structure.

Forbidden

  • Must not add or remove text in a way that breaks a page's narrative, section continuity, or reader journey.
  • Must not use meta language about edits, removed text, prompt phases, implementation history, or task history.
  • Must not make patchwork edits that read as isolated insertions.
  • Must not spread edits across unrelated docs files when a focused page or section update is enough.
  • Must not change docs organization, navigation, or page purpose without updating affected pages and configuration coherently.
  • Must not add comments that restate content or describe editing activity.
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. 1mo ago First seen · 28 lines · 400 tokens per session scan A 5a57a5d435ed

Subscribe to this mod's changes

caracal docs-documentation.instructions.md is an instructions file published in the GitHub repository Garudex-Labs/caracal (225 stars, last pushed yesterday), licensed Apache-2.0. It adds 400 tokens to every session, about $0.0016 per session on Opus 5.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

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,786 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens