Skip to content

docs: toolkit, not build plugin #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arielshulman29 merged 1 commit into from
Aug 27, 2026
Merged

docs: toolkit, not build plugin #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
The web was built for humans. Now a new era begins: AI agents that browse, read, and act on a
site's behalf — and most sites are invisible to them: no map, no context, no way in.

`@ora-ai/ax` is a build plugin and CLI that makes a Next.js app discoverable, legible, and usable by
agents.
`@ora-ai/ax` is the agent-experience toolkit for Next.js: a build step that generates and
publishes your agent-facing artifacts, and an edge middleware that serves agents at runtime.

## One-time setup

Expand Down Expand Up @@ -59,7 +59,7 @@ coding agent at it after a build and let it work through what's left.

A regular dependency, not a dev one: `@ora-ai/ax/middleware` is imported by your `middleware.ts`
and bundled into the production build (the entry is Web-API-only with zero runtime dependencies, so
it's edge-safe).
it's edge-safe). Skip the middleware and ax is build-time only — a devDependency works then too.

`ax init` wires two build hooks. `prebuild: ax manifest` builds a lightweight map of your site —
routes, gated paths, discovery artifacts — before Next.js compiles your middleware.
Expand Down
Loading