Skip to content

Commit 5b0a38b

Browse files
committed
docs: point remix skill to package readmes
1 parent 122eee2 commit 5b0a38b

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update the default app template's Remix agent skill to point agents at the full `remix/*` README files shipped in `node_modules/remix`.

template/.agents/skills/remix/SKILL.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ description: Build and review Remix 3 applications using the `remix` npm package
88
Use this skill for end-to-end Remix app work. It should help the agent choose the right layer
99
first, reach for the right package, and avoid the most common Remix-specific mistakes.
1010

11+
## Full Package Documentation
12+
13+
This skill is the quick guide. When you need fuller API documentation, examples, or package-specific
14+
details for a `remix/*` subpath, read that subpath's README next. The published `remix` package
15+
includes those READMEs next to its generated source files:
16+
`node_modules/remix/src/<subpath>/README.md`.
17+
18+
Examples:
19+
20+
- `remix/fetch-router` -> `node_modules/remix/src/fetch-router/README.md`
21+
- `remix/ui/button` -> `node_modules/remix/src/ui/button/README.md`
22+
- `remix/session/cookie-storage` -> `node_modules/remix/src/session/cookie-storage/README.md`
23+
1124
## What Remix Is
1225

1326
Remix 3 is a server-first web framework built on Web APIs such as `Request`, `Response`, `URL`,

0 commit comments

Comments
 (0)