← Back

CLAUDE.md & AGENTS.md

Real examples from this repository — the project-level config files that Claude Code and Codex read at session start

CLAUDE.md
AGENTS.md
CLAUDE.md

Read automatically by Claude Code at session start. Provides project context, conventions, and development instructions. Generated via /init and committed to the repo root.

# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code)
when working with code in this repository.

## Project Overview

A static reference site comparing the Claude Code and ChatGPT/Codex
extension ecosystems. The site covers Commands, MCP/Tools, Skills,
Hooks, and Plugins for both platforms via interactive cheatsheets and
concept reference pages.

## Architecture

- Static HTML site — no build step, no framework, no bundler
- All pages are self-contained HTML files with inline CSS and JS
- Served via GitHub Pages from the `docs/` directory on `main`
- Ecosystem cheatsheets use React 18 (CDN/UMD) with Babel standalone

## Key Files

- `docs/index.html` — Landing page
- `docs/claude-ecosystem-cheatsheet.html` — Claude ecosystem (React)
- `docs/claude-concepts.html` — Claude concepts (plain HTML)
- `docs/chatgpt-ecosystem-cheatsheet.html` — ChatGPT ecosystem (React)
- `docs/chatgpt-concepts.html` — ChatGPT concepts (plain HTML)

## Development

python -m http.server 8000 --directory docs

## Conventions

- Each page is standalone — styles and scripts are inlined
- Claude Code brand color: #d97757
- OpenAI brand color: #10a37f
- 2-space indentation for HTML/CSS/JS
- Lowercase hyphenated filenames with platform prefix
AGENTS.md

Read automatically by OpenAI Codex at session start. The equivalent of CLAUDE.md for the Codex ecosystem. Generated via /init and committed to the repo root.

# Repository Guidelines

## Project Structure & Module Organization

This repository is a static documentation site served from `docs/`
via GitHub Pages. The main entry point is `docs/index.html`.
Platform-specific reference pages live alongside it:

- `docs/claude-ecosystem-cheatsheet.html`
- `docs/claude-concepts.html`
- `docs/chatgpt-ecosystem-cheatsheet.html`
- `docs/chatgpt-concepts.html`

There is no `src/` or shared asset pipeline. Each page is
self-contained with inline HTML, CSS, and JavaScript.

## Build, Test, and Development Commands

No install or build step is required.
- `python -m http.server 8000 --directory docs`
- Open `http://localhost:8000` to verify navigation and layout.
- `git status` checks that only intended files changed.

## Coding Style & Naming Conventions

Use standard HTML, CSS, and vanilla JavaScript with consistent
2-space indentation. Keep pages standalone: prefer inline styles
and scripts over introducing shared build tooling. Name new pages
with lowercase hyphenated filenames.

Brand colors:
- Claude: #d97757
- OpenAI: #10a37f

## Testing Guidelines

No automated test suite. Validate changes manually in a browser.
Check links, responsive layout, and interactive cheatsheet behavior.

## Commit & Pull Request Guidelines

Short, imperative commit messages. PRs should include a brief
summary, affected pages, and screenshots for UI changes.