with one click
pair-framework
// Entry skill for assistants working on the Pair v4 framework repository.
// Entry skill for assistants working on the Pair v4 framework repository.
| name | Pair Framework |
| slug | pair |
| version | 4.0-alpha |
| description | Entry skill for assistants working on the Pair v4 framework repository. |
| tags | ["php","pair","framework","review"] |
| language | en |
Use this file as the compact quick-start companion to AGENTS.md.
Read AGENTS.md first.
Then use this file to move quickly through the repository without losing the main workflow and output rules.
This quick-start assumes Pair v4 on the default branch. The authoritative version-scope note lives in AGENTS.md.
Framework development in this repository:
The goal is to produce safe, minimal, reviewable changes.
Use this file for navigation, not as a second source of truth.
AGENTS.md.Use this decision guide to avoid reading too much documentation:
AGENTS.md, then use this file for navigation.PAIR_ARCHITECTURE.md.PAIR_PATTERNS.md.PAIR_CONTEXT.md.PAIR_TASKS.md.Start with AGENTS.md and SKILL.md, then stop unless the task still needs deeper context.
Use the official Pair wiki when the task touches one of these areas:
Router_init(), model/view loading, and PRG flows: Controllerrender(), assigned variables, and layout behavior: ViewActiveRecordFormdata-* directives and lightweight helpers: PairUI.js.env configurationPrefer these official docs over generic framework assumptions when behavior is unclear.
Use this map to find the right area quickly before searching broadly:
src/Core: application lifecycle, router, controller, model, view, logger, environment.src/Orm: ActiveRecord, query builder, collections, database access.src/Api: API controllers, request/response wrappers, middleware, throttling, OpenAPI support.src/Html: forms, widgets, menus, render helpers, form controls.src/Helpers: reusable framework helpers and utility-style classes.src/Services: integrations with external services and provider-specific logic.src/Models: framework models built on Pair ORM.src/Push: push notification delivery and subscription handling.src/Exceptions: framework exception types and error codes.src/Traits: small reusable behavior shared across classes.assets: PairUI and frontend-side JavaScript helpers.translations: localization resources.If the task touches request handling, check src/Core, src/Api, and nearby helpers before creating new flow logic.
If the task touches UI or forms, check src/Html and assets before adding new frontend patterns.
When locating code, prefer targeted searches over broad grep-style scans:
src/Html and assets together.src/Api first, then src/Core, then related models/helpers.src/Orm and then in the model using that behavior.Useful starting points:
src/Api/Request.php, src/Core/Controller.phpsrc/Html/Form.php, src/Html/FormControl.phpassets/PairUI.jssrc/Core/Application.php, src/Core/Router.phpIf a search returns too many matches, narrow by namespace or directory before reading more files.
Before editing, confirm these high-risk assumptions:
Use these default flows for common tasks.
The framework provides:
Agents should reuse existing framework components instead of reimplementing similar functionality.
Document ownership and conflict resolution are defined in AGENTS.md.
Use deeper docs only for their narrow role:
AGENTS.md: authoritative workflow, technical conventions, and output contractPAIR_ARCHITECTURE.md: framework internals and request flowPAIR_CONTEXT.md: anti-import guardrailsPAIR_PATTERNS.md: idiomatic code shape and examplesPAIR_TASKS.md: extra guidance for broader or higher-risk tasksRead the minimum set needed for the task. More documentation is not automatically better if it delays a safe, pattern-consistent change.
[HINT] Download the complete skill directory including SKILL.md and all related files