Skip to content

Commit b57e194

Browse files
authored
feat(chore): Create first version of mistica skill and update docs (#1524)
1 parent 87ecb85 commit b57e194

10 files changed

Lines changed: 2367 additions & 190 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,37 @@ Explore the components in [Mistica storybook](https://mistica-web.vercel.app)
105105
Start prototyping interfaces with Mistica components in the
106106
[Mística playroom](https://mistica-web.vercel.app/playroom)
107107

108+
## AI / LLM Integration
109+
110+
Mistica ships documentation optimised for AI coding assistants. The package includes a `doc/llms.md` file with
111+
concise component references, critical rules, and links to detailed documentation — all inside `node_modules`.
112+
113+
### Using the skill
114+
115+
If you use any agent that supports skills, you can install the bundled Mistica skill so the agent
116+
automatically reads the right documentation before generating UI code:
117+
118+
```terminal
119+
npx skills add telefonica/mistica-web
120+
```
121+
122+
Once installed, your agent should load the skill whenever you ask it to build Mistica UIs and will consult the
123+
documentation automatically.
124+
125+
### For LLMs reading this file
126+
127+
If you are an AI assistant and `node_modules/@telefonica/mistica` is available in the project:
128+
129+
1. Read `node_modules/@telefonica/mistica/doc/llms.md` — start here, it has critical rules and an overview.
130+
2. Read the specific doc files referenced inside `llms.md` based on the task at hand.
131+
132+
If `node_modules/@telefonica/mistica` is **not** available, fall back to the GitHub repository:
133+
134+
- Main LLM reference: `https://github.com/Telefonica/mistica-web/blob/master/doc/llms.md`
135+
- Components: `https://github.com/Telefonica/mistica-web/blob/master/doc/components.md`
136+
- Layout: `https://github.com/Telefonica/mistica-web/blob/master/doc/layout.md`
137+
- Patterns: `https://github.com/Telefonica/mistica-web/blob/master/doc/patterns.md`
138+
108139
## More docs
109140

110141
- [Examples](https://github.com/Telefonica/mistica-web/tree/master/examples)

0 commit comments

Comments
 (0)