mkdocs.yml

site_name: Codex Agentic Patterns
site_description: "Learn 17 production AI agent patterns extracted from OpenAI Codex CLI. Python implementations with hands-on examples for prompt chaining, tool use, sandbox escalation, and more."
site_url: https://artvandelay.github.io/codex-agentic-patterns/
repo_url: https://github.com/artvandelay/codex-agentic-patterns
repo_name: artvandelay/codex-agentic-patterns
edit_uri: edit/main/
docs_dir: docs

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - minify:
      minify_html: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: artvandelay
      repo: codex-agentic-patterns
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Link validation settings
validation:
  links:
    not_found: warn
    absolute_links: warn

nav:
  - Home: index.md
  - Backstory: context.md
  - Chapter 1 - Prompt Chaining: learning-material/01-prompt-chaining/README.md
  - Chapter 2 - Routing: learning-material/02-routing/README.md
  - Chapter 3 - Parallelization: learning-material/03-parallelization/README.md
  - Chapter 4 - Tool Use: learning-material/05-tool-use/README.md
  - Chapter 5 - Planning: learning-material/06-planning/README.md
  - Chapter 6 - Reflection: learning-material/07-reflection/README.md
  - Chapter 7 - Memory Management: learning-material/08-memory-management/README.md
  - Chapter 8 - MCP Integration: learning-material/10-mcp-integration/README.md
  - Chapter 9 - Exception Handling: learning-material/12-exception-handling/README.md
  - Chapter 10 - Human-in-the-Loop: learning-material/13-human-in-the-loop/README.md
  - Chapter 11 - Knowledge Retrieval: learning-material/14-knowledge-retrieval/README.md
  - Chapter 12 - Reasoning: learning-material/15-reasoning/README.md
  - Chapter 13 - Sandbox Escalation: learning-material/16-sandbox-escalation/README.md
  - Chapter 14 - Turn Diff Tracking: learning-material/17-turn-diff-tracking/README.md
  - Chapter 15 - Rollout System: learning-material/18-rollout-system/README.md
  - Chapter 16 - Inter-Agent Communication: learning-material/19-inter-agent-communication/README.md
  - Chapter 17 - Evaluation & Monitoring: learning-material/20-evaluation-monitoring/README.md
  - Complete Agent Example: learning-material/complete-agent-example/README.md

extra:
  homepage: https://artvandelay.github.io/codex-agentic-patterns/
  keywords: "AI agents, agentic patterns, OpenAI Codex, Python AI, LangChain, agent frameworks, prompt chaining, tool use, production AI, sandbox escalation, MCP integration"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/artvandelay/codex-agentic-patterns
      name: View on GitHub
    - icon: fontawesome/brands/hacker-news
      link: https://news.ycombinator.com/item?id=45509853
      name: Discuss on Hacker News
    - icon: fontawesome/solid/book
      link: https://docs.google.com/document/d/1rsaK53T3Lg5KoGwvf8ukOUvbELRtH-V0LnOIFDxBryE/preview
      name: Original Textbook
    - icon: fontawesome/solid/code
      link: https://github.com/openai/codex
      name: OpenAI Codex CLI
  generator: false
  status:
    new: Recently added
    deprecated: Deprecated
  tags:
    AI Agents: ai-agents
    Python: python
    Production: production
    Advanced: advanced

extra_javascript:
  - javascripts/analytics.js

copyright: |
  Copyright &copy; 2025 Codex Agentic Patterns Contributors<br>
  Built with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> • 
  Powered by <a href="https://cursor.sh/" target="_blank">Cursor</a> under heavy supervision of humans<br>
  Based on <a href="https://docs.google.com/document/d/1rsaK53T3Lg5KoGwvf8ukOUvbELRtH-V0LnOIFDxBryE/preview" target="_blank">Agentic Design Patterns</a> • 
  Patterns extracted from <a href="https://github.com/openai/codex" target="_blank">OpenAI Codex CLI</a>