Skip to content

Commit a360ff9

Browse files
committed
update README
1 parent ba28155 commit a360ff9

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ const url = getPlaygroundUrl({
205205
},
206206
});
207207

208+
// this URL can be shared
208209
console.log(url);
209210
```
210211

@@ -218,6 +219,8 @@ https://livecodes.io/docs/
218219

219220
The documentations include demos, code samples, screenshots, [Storybook](https://livecodes.io/stories) and [TypeScript types](https://livecodes.io/docs/sdk/js-ts#typescript-types).
220221

222+
See below for documentations for [contributors](#contribution) and [AI models](#for-ai-agents).
223+
221224
## Updates
222225

223226
Keep up with the latest changes:
@@ -246,13 +249,26 @@ Please refer to the [contribution guide](https://github.com/live-codes/livecodes
246249

247250
## For AI Agents
248251

252+
### llms.txt
253+
254+
For developers working with AI agents and language models, we provide specialized documentation files following the [llms.txt specification](https://llmstxt.org/):
255+
256+
- [llms.txt](https://livecodes.io/docs/llms.txt) - Concise documentation optimized for LLM context windows
257+
- [llms-full.txt](https://livecodes.io/docs/llms-full.txt) - Comprehensive documentation including all referenced URLs
258+
259+
These files provide LLM-friendly content in a standardized format, helping language models understand and work with LiveCodes documentation. The format is designed to be both human and LLM readable.
260+
261+
### Intent Skills
262+
249263
If you use an AI coding agent, run:
250264

251265
```bash
252266
npx @tanstack/intent@latest install
253267
```
254268

255-
This loads the Intent skills for LiveCodes. See [skills/livecodes/SKILL.md](https://github.com/live-codes/livecodes/blob/HEAD/skills/livecodes/SKILL.md) for the skill index.
269+
This loads the Intent skills for LiveCodes SDK. See [skills/livecodes/SKILL.md](https://github.com/live-codes/livecodes/blob/HEAD/skills/livecodes/SKILL.md) for the skill index.
270+
271+
### System Documentation
256272

257273
For internal architecture and system documentation, see [docs/docs/contribution/](https://github.com/live-codes/livecodes/blob/HEAD/docs/docs/contribution/README.md).
258274

@@ -334,7 +350,7 @@ Packages used by LiveCodes and their licenses are [listed here](https://github.c
334350

335351
[MIT](https://github.com/live-codes/livecodes/blob/HEAD/LICENSE) License © [Hatem Hosny](https://github.com/hatemhosny)
336352

337-
## Sponsor
353+
## Sponsor 💚
338354

339355
LiveCodes is free and open-source. The app does not contain ads or require subscription. It allows unlimited usage without any restrictions.
340356

0 commit comments

Comments
 (0)