# @nhtio/lucid-resourceful

A decorator-driven AdonisJS library that lets you annotate Lucid ORM models with metadata to automatically generate CRUD controllers, validation rules, OpenAPI schemas, and a unified query interface.

For more information, see the [official documentation](https://lucid-resourceful.nht.io)

## Documentation

This repository keeps two distinct documentation trees:

- **User documentation** — the published guide for library consumers lives in [`docs/`](docs/) (a VitePress site, served at <https://lucid-resourceful.nht.io>). Run it locally with `pnpm docs:dev`.
- **Engineering docs — intent & decisions** — architecture overview, decision records (ADRs), feature designs (specs), and implementation tasks live in [`docs/_internal/`](docs/_internal/). This tree is the source of truth for *why* the code is the way it is; the code itself is the source of truth for *behavior*. It is excluded from the published VitePress site (`srcExclude` in `docs/.vitepress/config.mts`).

Start at [`docs/_internal/README.md`](docs/_internal/README.md) for the layout and the rules of the road.