docs: move intro to guide and set up llmstxt

Author: Th1nkK1D

README.md

@@ -9,6 +9,7 @@ Using [TypeBox](https://github.com/sinclairzx81/typebox), [d3-dsv](https://d3js.
 [![NPM Version](https://img.shields.io/npm/v/sheethuahua)](https://www.npmjs.com/package/sheethuahua)
 
 [📖 View full documentation](https://punchupworld.github.io/sheethuahua/)
+[🤖 Use llms.txt](https://punchupworld.github.io/sheethuahua/llms.txt)
 
 <!-- #region doc-index -->
 

bun.lock

@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress';
+import llmstxt from 'vitepress-plugin-llms';
 import { generateSidebar } from 'vitepress-sidebar';
 import typedocSidebar from '../references/typedoc-sidebar.json';
 
@@ -39,7 +40,7 @@ export default defineConfig({
 			{ text: 'References', link: '/references.html' },
 		],
 		sidebar: [
-			// @ts-ignore
+			// @ts-expect-error incompatible type
 			...(generateSidebar({
 				excludePattern: ['references'],
 				documentRootPath: 'docs',
@@ -73,4 +74,11 @@ export default defineConfig({
 			level: [2, 3],
 		},
 	},
+	vite: {
+		plugins: [
+			llmstxt({
+				domain: 'https://punchupworld.github.io',
+			}),
+		],
+	},
 });

docs/.vitepress/config.ts

@@ -1,3 +1,7 @@
+---
+description: Overview of Sheethuahua — a set of schemas, transformers, type-safe parsers and formatters for CSV and Google Sheets data, with notes on Google Sheets rate limits.
+---
+
 # Introduction
 
 CSV (or Google Sheets) is an easy to used data format. But it is quite unpredictable, and not that flexible. We aim to help you with **"Sheethuahua"**, a set of schemas, transformers, type-safe parsers and formatters. What you need to do is:

docs/introduction.md docs/guide/0-introduction.mddocs/introduction.md renamed to docs/guide/0-introduction.md

@@ -1,3 +1,7 @@
+---
+description: Installation instructions for the sheethuahua npm package (npm, yarn, pnpm, bun) and example imports of core functions.
+---
+
 # Getting Started
 
 Sheethuahua is available on [NPM](https://www.npmjs.com/package/sheethuahua) package repository.
@@ -41,3 +45,8 @@ import {
 	// ...
 } from 'sheethuahua';
 ```
+
+::: tip
+
+🤖 LLM texts are available in [standard](/llms.txt) and [full](/llms-full.txt) version
+:::

docs/guide/1-getting-started.md

@@ -1,3 +1,7 @@
+---
+description: Schema definition using Column, Object, and Tuple — including nested schemas and type inference with StaticDecode.
+---
+
 # Schema
 
 Schemas define how each row from CSV/Sheet will be transformed into.

docs/guide/2-schema.md

@@ -1,3 +1,7 @@
+---
+description: Transformers that decode/encode CSV string cells into typed values — built-in transformers (asString, asNumber, asBoolean, asDate, asOneOf, asArray), custom transformers via createTransformer, and optional/fallback variants.
+---
+
 # Transformer
 
 Every cell in CSV/Sheets is a `string`. Transformers contain instructions about how to convert a string of each cell to be the data you want (decode) and convert it back (encode). `Column()` requires a transformer in the 2nd argument.

docs/guide/3-transformer.md

@@ -1,3 +1,7 @@
+---
+description: Parsing CSV data from different sources — parseCsv for strings, fetchCsv for URLs, and Spreadsheet for Google Sheets, with debugging options.
+---
+
 # Parser
 
 Parser validate and decode the input CSV from the given _data source_ and the _schema_. If validation has failed, the error will be thrown.

docs/guide/4-parser.md

@@ -1,3 +1,7 @@
+---
+description: Formatting JavaScript data back to CSV string using formatToCsv and schema-defined encoders — the inverse of parsing.
+---
+
 # Formatter
 
 Formatter is the opposite of parser: it validates and encodes JavaScript data back to the CSV string with the given _schema_. If validation has failed, the error will be thrown.

docs/guide/5-formatter.md

@@ -67,6 +67,7 @@
 		"typescript": "^5.6.2",
 		"typescript-eslint": "^8.33.1",
 		"vitepress": "^1.4.2",
+		"vitepress-plugin-llms": "^1.12.2",
 		"vitepress-sidebar": "^1.28.0"
 	}
 }