AI coding agents

Give coding agents such as Claude Code, Codex and Cursor the Nuxt Tour documentation that matches the installed version, through a short pointer in your project's AGENTS.md.

Set up coding agents

Agent setup

@lupinum/nuxt-tour ships its documentation inside the package for coding agents such as Claude Code, Codex and Cursor. The pages match the installed version, so an agent does not follow the website for a different version.

To set it up, give your coding agent this task:

Set up @lupinum/nuxt-tour for coding agents as described under "Agent setup" in its README.

Steps for the agent

Find node_modules/@lupinum/nuxt-tour/dist/agent/AGENTS.md. Look in the directory of the project that depends on @lupinum/nuxt-tour first, then in its parent directories up to the repository root (workspaces can hoist packages). Read it; it lists the documentation pages.
Add the section below to the project's agent instructions: AGENTS.md, or CLAUDE.md if the project has only that file. If it has neither, create AGENTS.md. Write the path relative to the repository root, through node_modules/@lupinum/nuxt-tour (for example apps/web/node_modules/@lupinum/nuxt-tour/... in a workspace). Never write a resolved path such as node_modules/.pnpm/...: it contains the version and breaks after an upgrade. If a section for @lupinum/nuxt-tour already exists, leave it as it is.
Use the path you found in place of the sample path:
md
```
## @lupinum/nuxt-tour

Before you change code that uses @lupinum/nuxt-tour, read
`node_modules/@lupinum/nuxt-tour/dist/agent/AGENTS.md` and the pages it
lists. They document the installed version. Prefer them over what you
remember about this package and over the website.
```
Do not copy the documentation into the project and do not install a skill. The section points into the installed package, so it stays correct after every upgrade or downgrade.

If the file does not exist, the installed version has no packaged documentation. Read the package README and its TypeScript types instead.