@fusion.dev/helix-docs 0.187.0 → 0.188.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,21 +8,15 @@ title: Using Helix with an agent
8
8
 
9
9
  # Using Helix with an agent
10
10
 
11
- **We publish this guide as a web page so that every tool can read it.** It began
12
- as `.claude/skills/using-helix/SKILL.md`, a file format that one vendor reads in
13
- a repository. Every other vendor reads its own file:
11
+ This guide is in two places, and both say the same thing:
14
12
 
15
- - Cursor reads `.cursor/rules`.
16
- - Copilot reads `.github/copilot-instructions.md`.
13
+ - this page, which [llms.txt](https://fusion.dev/llms.txt) indexes
14
+ - `skills/helix/SKILL.md` inside `@fusion.dev/helix`, which matches the version
15
+ you installed and works offline
17
16
 
18
- If you install the published packages, you have none of these files. You have
19
- this site and no checkout of our repository.
20
-
21
- So the guide lives in one place, here, at a URL that
22
- [llms.txt](https://fusion.dev/llms.txt) indexes and that each of those files can
23
- link to. Paste the link into the file your tool reads. [The MCP
24
- server](./coding-agents) works with any vendor and runs code, and Claude,
25
- Cursor, Windsurf, and Zed all support it.
17
+ [Link your tool to this guide](#link-your-tool-to-this-guide) says how to point
18
+ each tool at one of them. [The MCP server](./coding-agents) works with any
19
+ vendor and runs code, and Claude, Cursor, Windsurf, and Zed all support it.
26
20
 
27
21
  ## Read the family before writing its tags
28
22
 
@@ -223,20 +217,28 @@ If you are adding a script to a recipe, use the component.
223
217
 
224
218
  ## Link your tool to this guide
225
219
 
226
- **Link to this page from your instructions file, and do not copy it.** Each tool
227
- that reads project instructions reads a file in your repository, and each tool
228
- reads a different one. A copy starts to go stale as soon as you paste it, and
229
- this page changes with the library.
220
+ **Point your tool at the guide, and do not copy it.** A copy starts to go stale
221
+ as soon as you paste it, and the guide changes with the library.
222
+
223
+ The skill in the package matches the Helix you installed. In Claude Code, link
224
+ it into your project's skills folder:
225
+
226
+ ```sh
227
+ mkdir -p .claude/skills
228
+ ln -s ../../node_modules/@fusion.dev/helix/skills/helix .claude/skills/helix
229
+ ```
230
+
231
+ Other tools read a file in your repository. Add a line to it that names the
232
+ skill, or this page:
230
233
 
231
234
  ```md
232
- Helix: read https://fusion.dev/helix/docs/using-helix-with-an-agent
233
- before writing components, and https://fusion.dev/helix/custom-elements.json
234
- for the API.
235
+ Helix: read node_modules/@fusion.dev/helix/skills/helix/SKILL.md before
236
+ writing components, and node_modules/@fusion.dev/helix/api.json for the API.
235
237
  ```
236
238
 
237
239
  | Tool | Where it goes |
238
240
  |---|---|
239
- | Claude Code | `AGENTS.md` or `CLAUDE.md`, or a skill in `.claude/skills/` |
241
+ | Claude Code | `.claude/skills/helix`, or a line in `AGENTS.md` or `CLAUDE.md` |
240
242
  | Cursor | `.cursor/rules/` |
241
243
  | GitHub Copilot | `.github/copilot-instructions.md` |
242
244
  | Anything else | Whatever it reads. The line is the same |
@@ -244,7 +246,7 @@ for the API.
244
246
  We do not write those files for you, and we chose this on purpose. You would
245
247
  have to maintain a file we generated in your repository against our changes. A
246
248
  tool that rewrote it on install would be a dependency you did not ask for, in a
247
- directory you own. You paste the line above, and you can delete it.
249
+ directory you own. You add the link or the line, and you can delete it.
248
250
 
249
251
  ## Install the Helix MCP server
250
252
 
@@ -61,8 +61,8 @@ export interface ReferenceOptions {
61
61
  * Frontmatter, emitted above the heading.
62
62
  *
63
63
  * Provenance rather than decoration: a generated document should say what it
64
- * was generated from, so a reader who finds one detached from this repository
65
- * can still tell where to look. Keys are written in the order given, because
64
+ * was generated from, so a reader who finds one on its own can still tell
65
+ * where to look. Keys are written in the order given, because
66
66
  * a reader scans the first line and `title` is what they want there.
67
67
  */
68
68
  frontmatter?: Array<[string, string]>;