Codex Agent Setup

This repository uses Codex-standard project files to guide future automated work.

Files And Folders

  • AGENTS.md: repository instructions loaded by Codex when working in this tree.
  • .codex/config.toml: project-scoped Codex settings, including subagent concurrency limits.
  • .codex/agents/: project-scoped custom subagents for focused review and site maintenance.
  • .agents/skills/: reusable repo skills that teach Codex specific workflows for this site.
  • .github/copilot-instructions.md: GitHub Copilot instructions for GitHub-side editing.

Custom Subagents

Project subagents live in .codex/agents/*.toml.

This repo defines:

  • docs-site-maintainer: use for Jekyll, Just the Docs, GitHub Pages, navigation, dependency, and build work.
  • content-reviewer: use for read-only editorial and structure review.
  • mermaid-designer: use for Mermaid and non-Mermaid visual explanation design, including format selection.
  • mermaid-reviewer: use for read-only Mermaid diagram and visual-format review.
  • deep-research-content-updater: use for read-only current-source research on GenAI coding, prompting, documentation, reproducibility, and tooling updates before editing content.
  • reference-auditor: use for read-only citation integrity, link health, and claim-source alignment audits.

The project config keeps subagent use intentionally shallow:

[agents]
max_threads = 4
max_depth = 1

Skills

Repo skills live under .agents/skills/<skill-name>/SKILL.md.

This repo defines:

  • just-the-docs-site: Jekyll, Just the Docs, Pages, and build workflow guidance.
  • prompt-template-curation: prompt-template rendering and copy/paste conventions.
  • mermaid-workflow-diagrams: visual-format selection, Mermaid diagram-type guidance, accessibility, and layout conventions.
  • deep-research-content-updates: source-quality and update-proposal workflow for latest practices and recommendations.
  • reference-source-audit: reference inventory, URL validation, and claim-support checking workflow.

When To Use Each Layer

  • Use AGENTS.md for stable rules that should always apply in this repository.
  • Use .codex/agents/ for focused subagents that can independently review or handle a bounded task.
  • Use .agents/skills/ for reusable procedures that should trigger when a task matches a specific workflow.
  • Use .github/copilot-instructions.md for GitHub and Copilot editing contexts outside local Codex.