@salesql/sql_components_vue3 2.1.0 → 2.1.1
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.
- package/README.md +37 -1
- package/llms-full.txt +1350 -0
- package/llms.txt +40 -0
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -79,8 +79,9 @@ salesql-components-library-vue3/
|
|
|
79
79
|
Desde la raíz:
|
|
80
80
|
|
|
81
81
|
```bash
|
|
82
|
-
pnpm build # build de la librería
|
|
82
|
+
pnpm build # build de la librería (regenera también los docs LLM)
|
|
83
83
|
pnpm dev:stories # arranca Histoire
|
|
84
|
+
pnpm docs:generate # regenera llms.txt + llms-full.txt (docs para agentes)
|
|
84
85
|
pnpm typecheck # chequeo estricto de tipos
|
|
85
86
|
pnpm changeset # crear un changeset
|
|
86
87
|
pnpm release:version # aplicar changeset y subir versión
|
|
@@ -126,6 +127,41 @@ Los estilos base se importan automáticamente desde la librería (`base.scss`).
|
|
|
126
127
|
|
|
127
128
|
---
|
|
128
129
|
|
|
130
|
+
## 🤖 Docs para agentes de IA (LLM)
|
|
131
|
+
|
|
132
|
+
El paquete publica documentación en **markdown plano**, pensada para que los agentes de
|
|
133
|
+
IA de los repos consumidores (frontend-app, etc.) entiendan la librería sin scrapear el
|
|
134
|
+
HTML de Histoire:
|
|
135
|
+
|
|
136
|
+
- **`llms-full.txt`** — todos los componentes en detalle (props, eventos, a11y, uso).
|
|
137
|
+
- **`llms.txt`** — índice liviano (formato [llms.txt](https://llmstxt.org)) que apunta al anterior.
|
|
138
|
+
|
|
139
|
+
Ambos se **autogeneran** desde los bloques `<docs lang="md">` de las `*.story.vue` (la
|
|
140
|
+
única fuente de verdad) y viajan dentro del paquete npm:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
pnpm docs:generate # regenera llms.txt + llms-full.txt (corre solo en `pnpm build`)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Como viajan en el paquete, un agente en un repo consumidor los lee **version-locked** a
|
|
147
|
+
lo que tiene instalado, sin red ni token de GitHub:
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
node_modules/@salesql/sql_components_vue3/llms-full.txt
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Enganche recomendado en el repo consumidor (su `AGENTS.md` / `CLAUDE.md`):
|
|
154
|
+
|
|
155
|
+
```md
|
|
156
|
+
Para usar `@salesql/sql_components_vue3`, leé primero
|
|
157
|
+
`node_modules/@salesql/sql_components_vue3/llms-full.txt` — props, eventos y uso de cada componente.
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
> ¿Querés docs más ricas? Agregá/mejorá el bloque `<docs>` de la story del componente:
|
|
161
|
+
> `llms-full.txt` se regenera solo en el próximo build.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
129
165
|
## 🛠️ Añadir un nuevo componente (Checklist)
|
|
130
166
|
|
|
131
167
|
> Convención de nombres: archivos **PascalCase** (`SqlX.vue`, `SqlX.story.vue`).
|