Skip to content

INSTRUCTIONS.md

Latest commit

 

History

History
89 lines (68 loc) · 4.55 KB

INSTRUCTIONS.md

File metadata and controls

89 lines (68 loc) · 4.55 KB

AI Instructions Navigation Guide

This repository has multiple instruction files for different AI tools and use cases. This guide helps you find the right instructions for your needs.

Quick Navigation

If you are... Use this file Purpose
GitHub Copilot copilot-instructions.md Primary instructions for coding agents, technical setup, build automation
Claude, ChatGPT, Gemini ../AGENTS.md Comprehensive guide for content creation, workflows, style guidelines
Claude with MCP ../CLAUDE.md Lightweight pointer with references to other resources

Instruction File Organization

docs-v2/
├── .github/
│   ├── copilot-instructions.md        # PRIMARY - GitHub Copilot instructions
│   ├── INSTRUCTIONS.md                # THIS FILE - Navigation guide
│   ├── agents/
│   │   └── typescript-hugo-agent.md   # Custom specialist for TypeScript/Hugo work
│   └── instructions/
│       ├── content.instructions.md    # Auto-loaded for content files
│       ├── layouts.instructions.md    # Auto-loaded for layout files
│       ├── api-docs.instructions.md   # Auto-loaded for API doc files
│       └── assets.instructions.md     # Auto-loaded for JS/TS files
├── .claude/                           # Claude MCP configuration
│   ├── agents/                        # Specialized agents for Claude
│   ├── commands/                      # Custom commands for Claude
│   ├── skills/                        # Claude skills
│   └── settings.json                  # Claude settings
├── AGENTS.md                          # Comprehensive guide for general AI assistants
└── CLAUDE.md                          # Pointer for Claude with MCP

What's in Each File

copilot-instructions.md - The primary instruction file with:

  • Quick command reference
  • Setup and testing procedures
  • Repository structure
  • Content guidelines and style
  • File pattern-specific instructions (auto-loaded)
  • Custom specialist agents
  • General documentation references

../AGENTS.md - Comprehensive guide for general AI assistants with:

  • Detailed content creation workflows
  • Common shortcode examples
  • Commit message format
  • Browser-based editing workflow

../CLAUDE.md - Lightweight pointer to other instruction resources

instructions/ - Auto-loaded pattern-specific instructions:

  • content.instructions.md - For Markdown content files (references Claude skills)
  • layouts.instructions.md - For Hugo template files
  • api-docs.instructions.md - For OpenAPI spec files
  • assets.instructions.md - For JavaScript/TypeScript files

agents/ - Custom specialist agents for complex tasks:

  • typescript-hugo-agent.md - TypeScript migration and Hugo asset pipeline
  • copilot-instructions-agent.md - Creating and managing Copilot instructions

../.claude/ - Claude MCP configuration with specialized agents, commands, and skills:

  • skills/ - Detailed workflow guidance (referenced by Copilot instructions)
  • commands/ - Custom Claude commands
  • agents/ - Claude-specific agents

Choosing the Right Instructions

Getting Started

  1. New to the repository? Start with ../README.md
  2. Using GitHub Copilot? Read copilot-instructions.md
  3. Using other AI assistants? Read ../AGENTS.md
  4. Using Claude with MCP? Check ../CLAUDE.md and ../.claude/
  5. Managing Copilot instructions? Use agents/copilot-instructions-agent.md