agent-skills: Instructions file for Codex

Authoring Agent Skills

Guidelines for creating skills in this repository.

Directory Structure

Skills live in the skills/ directory:

skills/
└── skill-name/
    ├── SKILL.md          # Required - main entry point
    └── references/       # Optional - detailed topic docs

Naming

Use lowercase with hyphens. The directory name must match the name field in SKILL.md frontmatter:

• react-router-framework-mode
• react-router-data-mode
• remix

SKILL.md Format

Follow the Agent Skills specification.

Required Frontmatter

---
name: skill-name
description: What this skill does. Be specific about when agents should activate it.
license: MIT
---

Recommended Sections

1. Title & Intro - Brief overview of the skill
2. When to Apply - Bullet list of specific trigger conditions
3. References - Table mapping topics to reference files
4. Version Compatibility - Feature/version requirements (if applicable)
5. Critical Patterns - Most important patterns with code examples
6. Further Documentation - Links to official docs

Example structure:

# Skill Name

Brief description of what the skill covers.

## When to Apply

- Specific condition that triggers this skill
- Another trigger condition
- Yet another trigger

## References

| Reference             | Use When       |
| --------------------- | -------------- |
| `references/topic.md` | Working with X |
| `references/other.md` | Implementing Y |

## Critical Patterns

Show the most important patterns here with code examples.

Size Guidelines

• Keep SKILL.md under 500 lines
• Move detailed reference material to references/
• Include only the most critical patterns inline

Reference Files

Reference files provide detailed guidance on specific topics.

Frontmatter

---
title: Topic Name
description: Brief description of what this reference covers
tags: [relevant, searchable, tags]
---