Documentation Index
This directory is the system of record for repository-local knowledge. Agents and humans should start here, then follow the narrowest document that matches the task.
Orientation
../ARCHITECTURE.md- system boundaries, runtime modes, codemap, invariants, and common change paths.setup.md- first-run development quickstart.ai-workflow.md- agent-first workflow, Laravel Boost harnessing, and how project skills fit together.doc-health.md- known documentation gaps and maintenance checks.
Implementation Guides
backend/index.md- Laravel/PHP conventions and backend change checklist.frontend/index.md- Vue/TypeScript conventions and frontend change checklist.backend/testing.md+.ai/skills/test-strategy/- verification commands and test selection (see skill for decision tree).workflows/hub-endpoints.md- planning and implementing NuxtHub API endpoints.workflows/openapi-tooling.md- linting and previewing the OpenAPI specification.workflows/processors.md- planning processor integrations and issuer onboarding.
Existing Detailed References
backend/setup.md- backend-specific local configuration.backend/testing.md- backend test suite commands and PHPUnit authoring conventions.backend/linting-and-formatting.md- Laravel Pint setup.backend/ai-tooling.md- Laravel Boost installation and guideline updates.frontend/development.md- frontend setup, commands, troubleshooting, and quality checks.modules/connect-api.md- Connect API guard, routing, response, and endpoint conventions.modules/secure-links/secure-links.md- Secure Link experience mode resolution and sale metadata rules.adrs/- accepted architectural decisions and ADR template.
Existing Processor References
processors/amazon.md- Amazon processor lifecycle, contract mappings, operator tooling, and support investigation.processors/amilon.md- Amilon processor lifecycle, contract mappings, operator tooling, and support investigation.processors/cadooz.md- Cadooz processor operations, settings, API lifecycle, and support investigation.processors/diggecard.md- Diggecard issuance, balance checks, configuration, and duplicate-order investigation.processors/epay.md- ePay voucher issuance, cancellation, host routing, and support investigation.processors/go-gift-v2.md- GoGift v2 basket lifecycle, retrieval, and duplicate-order investigation.processors/incomm.md- InComm async issuance, retrieval, balance, cancellation, and operational tooling.processors/mbl-v2.md- MBLv2 processor lifecycle, denomination mappings, and support escalation guidance.processors/ogloba.md- Ogloba order creation, confirmation, retrieval, and support investigation.processors/svs-ecard.md- SVSECard issue, balance, reload, cancellation, and support investigation.processors/vananam.md- Vananam asynchronous URL fulfilment, retrieval, and retry investigation.processors/you-got-a-gift.md- You Got A Gift issue, processor settings, and support investigation.
How To Add Knowledge
Add knowledge where future agents will look for it:
- Put stable architecture and boundary rules in
../ARCHITECTURE.md. - Put domain workflows in focused docs under
docs/. - Put repeatable execution steps in
.ai/skills/<skill-name>/SKILL.md. - Put Laravel-version-specific policy in Laravel Boost guidelines or project skills.
- Promote repeated review feedback into docs, tests, lints, or CI checks.
AGENTS.md and CLAUDE.md are generated by Boost — do not edit them directly. Project-specific agent guidance belongs in .ai/guidelines/ and .ai/skills/.