AGENTS.md · git:20260623.10235d9 · 2026-06-23 · sha256 37218e94818a1165

AGENTS.md git:20260623.10235d9A

Immutable. This exact content is served forever at /api/v1/blob/37218e94818a1165.

# Development Guidelines for Dile Components

## Repository overview

This repository is a monorepo for the Dile Components library. It contains multiple packages under the `packages/` directory, each focused on a different area of the component ecosystem.

### Packages

- `packages/ui` — UI components for graphical interfaces, published as `@dile/ui`
- `packages/utils` — utility components, published as `@dile/utils`
- `packages/crud` — CRUD-related components, published as `@dile/crud`
- `packages/editor` — rich text / editor components, published as `@dile/editor`
- `packages/icons` — icon assets and helpers, published as `@dile/icons`
- `packages/iconlib` — icon library web component implementations
- `packages/lib` — shared library helpers and app-oriented abstractions

## Documentation site

The documentation site project is located in the `docs/` directory. This is the source for the Eleventy-based documentation website.

## Demos

Interactive demos are stored in the `demos/` directory.

- UI component demos go in `demos/ui/`
- Utils component demos go in `demos/utils/`
- CRUD component demos go in `demos/crud/`

## When creating a new component

When implementing a new component, follow these conventions:

1. Create the component in the appropriate package folder under `packages/`.
2. Create a demo file in the matching demos folder:
   - UI components: `demos/ui/`
   - Utils components: `demos/utils/`
   - CRUD components: `demos/crud/`
3. Create documentation for the component:
   - UI components: `docs/components/`
   - CRUD components: `docs/crud/`
4. Add the demo to the corresponding demo index file:
   - CRUD components: `demos/crud/index.html`
   - Other components: `demos/index.html`
   - Keep the demo list in alphabetical order.
5. Use the existing component documentation files as a base for style and structure.
6. Follow the naming and file organization patterns already used by existing components in the repository.
7. Keep the documentation concise, practical, and aligned with the existing docs format.

## Development workflow

- Use the existing component folders and files as reference points before creating new ones.
- Prefer small, focused components that follow the conventions already used in this repository.
- Keep demos and documentation in sync with the implementation.
- When adding a new component, make sure it is easy to discover through its demo and its documentation page.