Skip to content

docs: show init's agent steps on a fresh create-next-app #72

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
JasonPaff merged 2 commits into from
Oct 2, 2026
Merged

docs: show init's agent steps on a fresh create-next-app #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a2d207
docs: show init's agent steps on a fresh create-next-app
JasonPaff Oct 2, 2026
2090172
Merge branch 'main' into jasonpaff/par-112-getting-started-shows-stal…
JasonPaff Oct 2, 2026
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
16 changes: 11 additions & 5 deletions docs/content/docs/getting-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,14 @@ paramour init
✔ wrapped next.config.ts with withTypedRoutes
✔ added "paramour" script to package.json
✔ wrote paramour-env.d.ts (1 route)
• no agent tooling detected — skipped agent skills (`paramour skills` installs to the portable .agents/skills/)
• no AGENTS.md or CLAUDE.md — skipped agents snippet
✔ installed agent skills → .agents/skills/paramour
✔ appended paramour section to AGENTS.md

setup:
✔ route directories: app/
✔ dependencies declared: paramour, @paramour-js/next
✔ tsconfig.json includes paramour-env.d.ts
✔ agent skills: .agents/skills/paramour up to date

Commit the generated artifact — `paramour check` verifies it stays current in CI.
```
Expand All @@ -75,12 +76,17 @@ Four things, each idempotent (rerunning init never clobbers your edits):
registry; commit it like a lockfile. The
[registry page](/docs/concepts/registry) explains how it works.

The two skipped steps are for projects with coding agents in the loop: when
The two agent lines in the output are for projects with coding agents in
the loop. When
init detects agent tooling (a `.claude/`, `.cursor/`, `.codex/`, or
`.agents/` directory, or a root `AGENTS.md`), it also installs the bundled
[agent skill](/docs/guides/ai-agents) and appends a paramour section to your
agent instructions file — so your agent learns the library the moment you
do. On a fresh `create-next-app` there's nothing to detect, hence the skips.
agent instructions file, so your agent learns the library the moment you
do. Current `create-next-app` writes an `AGENTS.md` (and a `CLAUDE.md` that
imports it), so both steps run on a fresh app: the skill lands in the
portable `.agents/skills/`, and the paramour section goes below Next's own
block in `AGENTS.md`, between its own markers. In a project with no agent
tooling, init skips both steps and says so.

## Define your first route

Expand Down
Loading