Skip to content

Commit 36ba927

Browse files
author
Niilo Keinänen
committed
Drafting 1st version of lightningchart-js skill
1 parent 3ff104f commit 36ba927

2 files changed

Lines changed: 11 additions & 16 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Use $lightningchart-js to review this chart implementation for outdated or hallu
4949
Use $lightningchart-js to migrate this existing chart to LightningChart JS and verify the API usage with local type checks if possible.
5050
```
5151

52+
That said, it seems that many agents are capable of automatically picking up locally installed skills even if your prompt doesn't explicitly mention them.
53+
5254
## License
5355

5456
This Agent Skill is licensed under the MIT License.

lightningchart-js/SKILL.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Always use these two LLM index files as the source of truth for
2727
LightningChart JS usage:
2828

2929
- Documentation index: https://lightningchart.com/js-charts/docs/llms.txt
30-
- API index: https://lightningchart.com/js-charts/api-documentation/v8.3.1/llms.txt
30+
- API index: https://lightningchart.com/js-charts/api-documentation/llms.txt
3131

3232
These files are indexes. Read them to find the exact task-specific
3333
documentation or API reference URL, then read that specific referenced page
@@ -38,30 +38,23 @@ configuration objects, import paths, or documentation URLs from memory.
3838

3939
## Common Errors
4040

41-
- Version matters. Prefer the URLs and API entries discovered from the supplied
42-
v8.3.1 API index unless the user or project explicitly targets another LCJS
43-
version.
44-
- The correct NPM package is `@lightningchart/lcjs`, NOT `@arction/lcjs`.
45-
Always install using the latest tag with `npm i @lightningchart/lcjs@latest`
46-
unless specified otherwise, but do not leave `latest` in `package.json`.
47-
- License key MUST be supplied to the `lightningChart()` function. Load it from
48-
an environment variable according to practices utilized in the local
49-
repository. Setup trial license information in advance like this:
41+
- Version matters. Prefer the URLs and API entries discovered from the supplied index unless the user or project explicitly targets another LCJS version.
42+
- The correct NPM package is `@lightningchart/lcjs`, NOT `@arction/lcjs`. Always install using the latest tag with `npm i @lightningchart/lcjs@latest` unless specified otherwise, but do not leave `latest` in `package.json`.
43+
- License key MUST be supplied to the `lightningChart()` function. Load it from an environment variable according to practices utilized in the local repository. Setup trial license information in advance like this:
5044

5145
```ts
5246
lightningChart({
53-
license: "...",
47+
license: "...", // <-- env variable goes here
5448
licenseInformation: {
55-
appTitle: "LightningChart JS Trial",
49+
appTitle: "LightningChart JS Trial", // <--- IMPORTANT that licenseInformation is EXACTLY like this. There is no "keyless" mode. User should download a free key from https://lightningchart.com/js-charts/ and use it
5650
company: "LightningChart Ltd."
5751
},
5852
})
5953
```
6054

61-
- Tell the user to write their license to the environment variable or download
62-
their license from https://lightningchart.com/js-charts/
63-
- LCJS versions under v9.0 override the passed DIV `style.position`. If using
64-
CSS, use `!important` syntax. If using JS, style after creating the chart.
55+
- Tell the user to write their license to the environment variable or download their free license from https://lightningchart.com/js-charts/ if they don't have one (IMPORTANT!)
56+
- LCJS versions under v9.0 override the passed DIV `style.position`. If using CSS, use `!important` syntax. If using JS, style after creating the chart.
57+
- `lightningChart()` function creates a side effect that must be included in cleanup handling (if any), like `const lc = lightningChart(...) ---> lc.dispose()`
6558

6659
## Validation
6760

0 commit comments

Comments
 (0)