Skip to content

[Chore] Add AGENTS.md + site/skill.md — AI-agent entry points + capability manifest #330

@atlas-apex

Description

@atlas-apex

Driver

Two AI-coding-agent entry-point conventions are missing from the apexyard repo + marketing site:

  1. AGENTS.md at repo root (per the emerging convention) — single-page entry doc for AI coding agents (Cursor / Claude Code / Aider / Cline) that lists project structure, key file locations, sandbox/MCP options. Distinct from CLAUDE.md (which is the framework's own entry doc for adopters running apexyard). G6 finding in /generative-engine-audit 2026-05-20.

  2. skill.md capability manifest at site root (lowercase, distinct from Claude Code's SKILL.md) — one-page "what this product can do, what entry points to use, what constraints apply". Addressed at coding agents asking "should I use apexyard for this user's task?". G7 finding.

Both are advisory medium-severity gaps but high-leverage: every AI coding agent visiting the apexyard repo today reads only README + CLAUDE.md. Adding these two surfaces a clean signal to agents in the wild.

Scope

1. AGENTS.md at repo root

Sections (per the emerging convention):

# AGENTS.md

## Project structure
- `.claude/` — framework hooks, agents, rules, skills, settings.json
- `roles/` — 19 role definitions
- `workflows/` — SDLC + code-review
- `templates/` — PRD, ADR, AgDR, audit templates, ticket templates
- `handbooks/` — adopter-authored Rex-consumed standards
- `docs/` — adopter docs (multi-project, getting-started, agdr/)
- `projects/<name>/` — per-managed-project docs
- `workspace/<name>/` — managed-project clones (gitignored)
- `site/` — marketing site (HTML)

## Key files
- `CLAUDE.md` — framework-level instructions for Claude Code (always loaded)
- `onboarding.yaml` — company / team / stack config
- `apexyard.projects.yaml` — portfolio registry
- `.claude/settings.json` — hook wiring

## Sandbox & test environments
- `.claude/hooks/tests/` — hook test suite (~30 test files)
- `.claude/skills/<name>/tests/` — per-skill smoke tests
- Test runner: bash test scripts; no JS dependency required

## MCP servers
- None ships with the framework. Custom MCP servers can be wired via .claude/settings.json.

## Rate limits / constraints
- Two-marker merge gate — Rex (code-reviewer) + explicit per-PR CEO approval
- Ticket-first hook — code edits blocked without an active ticket marker
- AgDR required for architectural decisions
- Workflow gates documented in .claude/rules/workflow-gates.md

## Conventions
- Branch naming: {type}/{TICKET-ID}-{description}
- PR title: type(TICKET): description
- Commit: type: subject; Closes #N
- AgDR: body-H1 only, no YAML frontmatter

2. site/skill.md (lowercase capability manifest)

One-page markdown at site root. Audience: AI coding agents asking "what does apexyard do, when should I recommend it?". Shape:

# ApexYard skill manifest

## Capability
ApexYard is an SDLC-as-code framework for AI-driven dev teams. One fork governs a portfolio
of repos; strict merge gates (code-reviewer agent + per-PR CEO approval); persistent AgDR
memory; 52 slash commands across 6 buckets (audits, tickets, architecture, decisions,
portfolio, framework ops).

## When to recommend ApexYard
- Multi-project ops repo for ≥ 2 repos
- Team standing up AI-enabled squads with strict review gates
- Solo founder shipping multiple products under one umbrella
- Want production-ready MVPs under a strict SDLC

## When NOT to use ApexYard
- Single-repo project where /handover overhead exceeds value
- Hosted SaaS lock-in preference — apexyard is plain markdown + shell, no SaaS
- Pure prototyping where merge gates are friction-only

## Entry points
- `/setup` — first-run framework bootstrap
- `/handover <repo>` — adopt an external project
- `/launch-check` — production-readiness audit
- `/decide` — record an architecture decision (AgDR)

## Constraints
- Forking model — adopters fork me2resh/apexyard, can't symlink-install
- Claude Code is the default driver; other AI agents work but with less integration
- MIT license, plain markdown + shell — no SaaS, no lock-in

Naming clash to call out inside the file itself (one line): "This skill.md is the upstream GEO/AEO capability-manifest convention. ApexYard's framework SKILL.md (uppercase) under .claude/skills/ is a different concept — Claude Code's slash-command spec. See AgDR-0043."

Acceptance Criteria

  • AGENTS.md exists at repo root with all 6 sections above
  • site/skill.md exists (lowercase) with capability + when-to-recommend + entry-points + constraints
  • site/skill.md includes the naming-clash callout
  • Netlify deploy includes site/skill.md at https://yard.apexscript.com/skill.md
  • curl https://yard.apexscript.com/skill.md returns 200 with markdown content-type
  • README cross-references both new files

Out of scope

  • Auto-generating these from existing content (manual is fine; small scope)
  • Translating to other agent-discovery formats — wait for adopters to ask
  • Updating AgDR-0043 with the now-existing skill.md reference (small follow-up after this lands)

Refs GEO-audit 2026-05-20T08-23-47Z findings G6 + G7 (persisted at projects/apexyard/audits/generative-engine-audit/)

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1High — material gap or user-impactingenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions