examples

Examples

This directory contains real-world examples showing the AI agent rules generator in action. Each example demonstrates the full input/output contract: a project description goes in, a complete rules system comes out.

Examples are versioned to show the generator's evolution across releases.

Example Structure

Every example follows this layout:

examples/
└── {example-name}/
    ├── project-description.md        # Input: shared across all versions
    ├── v1.0/                         # Historical snapshot (single target)
    │   └── generated/
    │       ├── .github/
    │       │   ├── instructions/
    │       │   └── prompts/
    │       └── docs/
    └── v1.1/                         # Multi-target output
        ├── copilot/
        │   └── generated/
        │       ├── .github/
        │       │   ├── instructions/   # Up to 8 instruction files
        │       │   └── prompts/        # Up to 8 prompt files
        │       └── docs/
        ├── cursor/
        │   └── generated/
        │       ├── .cursor/
        │       │   └── rules/          # 7–9 .mdc rule files
        │       └── docs/
        └── codex/
            └── generated/
                ├── AGENTS.md           # Consolidated instructions (≤32 KiB)
                ├── .agents/
                │   └── skills/         # 6–8 skill files
                └── docs/

Shared output (docs/) is generated per-target — each subdirectory is self-contained.

Available Examples

Example	Version	Targets	Stack	Description
glitch-payment-gateway	v1.0	Copilot	PHP · WordPress · WooCommerce	Original output — 5 instruction files, 4 prompts (historical snapshot)
glitch-payment-gateway	v1.1	Copilot · Cursor · Codex	PHP · WordPress · WooCommerce	Updated multi-target output from the same project description

Guidelines for Examples

What belongs in an example

• project-description.md — The input that the generator consumes. Shared across all versions. Should be realistic and descriptive enough to produce meaningful output.
• v{X.Y}/generated/ (or v{X.Y}/{target}/generated/ for multi-target versions) — The full output produced by running the generator prompt against the project description. Should include all generated files for that target.

Version conventions

• v1.0 — The original generator output (Copilot-only). Preserved as a historical snapshot.
• v1.1 — Multi-target output. Contains copilot/, cursor/, and codex/ subdirectories, each with its own self-contained generated/ directory.
• Future versions follow the same pattern. Each version is a complete snapshot, not an incremental diff.

Safety rules

• No secrets or credentials. API keys, passwords, tokens, and webhook secrets must be placeholder values or omitted entirely.
• No private client information. Company names, real merchant IDs, internal URLs, or proprietary business logic must be fictional or anonymized.
• No environment-specific paths. Absolute filesystem paths should be replaced with relative paths or generic placeholders.
• Realistic but safe. Examples should feel like real projects without exposing anything sensitive.

Adding a new example

1. Create a new directory under examples/ with a descriptive kebab-case name.
2. Add project-description.md with a thorough project description.
3. Run the generator prompt against the description for each target you want to showcase.
4. Place generated files under v{X.Y}/{target}/generated/ (or v{X.Y}/generated/ for single-target).
5. Review for secrets, credentials, and private information — remove all of them.
6. Add a row to the "Available Examples" table in this README.