Skip to main content

​
Agent Documentation

This directory contains detailed guides for AI agents working on Inly Core.

​
File Structure

docs/agent/
├── overview.md            # Overview of agent documentation
├── testing.md             # Test patterns and commands
├── git-workflow.md        # Commits, releases, and commitlint
├── package-structure.md   # Publishing system and organization
├── ui-conventions.md      # shadcn components and React patterns
├── localization.md        # i18n patterns
└── pre-commit-hooks.md    # Husky and lint-staged setup

​
Progressive Disclosure

The root AGENT.md contains only essential information needed for every task. Detailed guides are organized by topic in this directory.

​
Maintenance

When adding new conventions or patterns, consider:
  1. Is this essential for every task? → Add to root AGENT.md
  2. Is this topic-specific? → Add to or create a topic file here
  3. Is this redundant with existing rules? → Don’t add it