copilot-kit documentation.instructions.md

A set of rules for writing project documentation, including README files, setup instructions, API references, examples, and code comments. Documentation explains how software works and how other developers use it.

In plain words
What is it for?
Use it when creating or reviewing README files, installation guides, configuration notes, API documentation, contribution instructions, and comments for public code.
Why use it?
It gives projects a consistent structure and makes setup and maintenance easier for people who did not write the code. It also helps keep public interfaces and examples understandable.

Instructions file for GitHub Copilot

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/ivanshtokov/copilot-kit/documentation
Clone the repo
git clone --depth 1 https://github.com/ivanshtokov/copilot-kit

Made for: GitHub Copilot.

Per session 294 This file is loaded in full into every session.
When invoked 294 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.00294 $0.00294
Opus 5 $0.00147 $0.00147
Sonnet 5 $0.00059 $0.00059
Haiku 4.5 $0.00029 $0.00029

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

Security

Grade A, and why

copilot-kit 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 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.

.github/instructions/documentation.instructions.md · 64 lines

What it actually says

Documentation Standards

🎯 Before Any Docs Work

READ: .github/skills/documentation-templates/SKILL.md

📋 README Structure

# Project Name

Brief description (1-2 sentences)

## Features
- Feature 1
- Feature 2

## Quick Start
\`\`\`bash
npm install
npm run dev
\`\`\`

## Documentation
- [Installation](docs/installation.md)
- [Configuration](docs/configuration.md)
- [API Reference](docs/api.md)

## Contributing
Guidelines for contributors

## License
MIT

✍️ Writing Style

  • Use active voice
  • Be concise and direct
  • Use code blocks for commands/code
  • Add examples for complex concepts
  • Use headings for structure (H2, H3)

📝 Code Comments

Type When to Use
// Comment Brief inline explanation
/** JSDoc */ Public API documentation
// TODO: Future improvements
// FIXME: Known issues

🔧 API Documentation

  • Document all public endpoints
  • Include request/response examples
  • Specify error codes and messages
  • Keep examples up-to-date with code
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 · 64 lines · 294 tokens per session scan A f2db1f5f1e59

Subscribe to this mod's changes

copilot-kit documentation.instructions.md is an instructions file published in the GitHub repository ivanshtokov/copilot-kit (2 stars, last pushed 7mo ago), licensed MIT. It adds 294 tokens to every session, about $0.0015 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.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

buildNext

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 · 6,785 tokens

next.js 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,296 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

Instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,040 tokens

langchain 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,345 tokens