DOC-364: Add llm.txt to documentation

surrealdb · Feb 25, 2025 · ff234ee · ff234ee
1 parent cdfdf7e
commit ff234ee
Show file tree

Hide file tree

Showing 3 changed files with 184 additions and 78 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -14,6 +14,7 @@ import { autolinkConfig } from './src/util/rehypeHeadingsConfig';
 import { rehypeNotesPlugin } from './src/util/rehypeNotesPlugin.mjs';
 
 import sitemap from '@astrojs/sitemap';
+import llms from 'vite-plugin-llms'
 
 const deployDomain = process.env.DEPLOY_DOMAIN ?? 'surrealdb.com';
 const site = `https://${deployDomain}`;
@@ -47,4 +48,11 @@ export default defineConfig({
         ],
         syntaxHighlight: false,
     },
+    vite: {
+        plugins: [
+            llms({
+              llmsDir: 'llms' // optional, defaults to 'llms'
+            })
+          ]
+      }
 });
diff --git a/llms/llms.txt b/llms/llms.txt
@@ -0,0 +1,97 @@
+# SurrealDB
+
+> SurrealDB is a scalable, distributed, document-oriented database with real-time querying capabilities and support for graph-based relationships.
+
+Things to remember when working with SurrealDB:
+
+- SurrealDB combines traditional database features with real-time capabilities and graph relationships
+- It supports multiple query languages including SurrealQL (native) and HTTP API
+- Can be embedded directly in applications or run as a standalone service
+- Supports both traditional table-based and graph-based data modeling
+- Provides real-time data synchronization and live queries
+
+## Get Started
+
+- [SurrealDB Installation Guide](https://surrealdb.com/docs/installation): Detailed instructions for installing SurrealDB
+- [SurrealDB Quick Start](https://surrealdb.com/docs/quickstart): A step-by-step guide to get you started with SurrealDB
+- [Get started with Surreal Cloud](https://surrealdb.com/docs/cloud/getting-started): A guide to get you started with Surreal Cloud
+- [Get started by installing SurrealDB](https://surrealdb.com/docs/surrealdb/introduction/start#getting-started-by-installing-surrealdb): A guide to get you started in-memory, Single-node On-Disk, Single Node On-disk, and Multi-node scalable deployments of SurrealDB
+- [Get started with JavaScript SDK](https://surrealdb.com/docs/sdk/javascript/start): A guide to get you started with the JavaScript SDK
+- [Get started with Rust SDK](https://surrealdb.com/docs/sdk/rust/setup): A guide to get you started with the Rust SDK
+- [Get started with Java SDK](https://surrealdb.com/docs/sdk/java/start): A guide to get you started with the Java SDK
+- [Get started with Golang SDK](https://surrealdb.com/docs/sdk/golang/start): A guide to get you started with the Golang SDK
+- [Get started with .NET SDK](https://surrealdb.com/docs/sdk/dotnet/start): A guide to get you started with the .NET SDK
+
+
+
+## Key Features
+
+- Multi-model database (document, graph, relational)
+- Real-time queries and data changes
+- Built-in authentication and row-level security
+- ACID compliant transactions
+- Supports complex data relationships
+- Embedded or distributed deployment options
+
+## API Access
+
+- HTTP API for RESTful operations
+- WebSocket connections for real-time updates
+- Native client libraries for multiple languages
+- GraphQL-like query capabilities
+
+## Docs
+
+- [SurrealDB Documentation](https://surrealdb.com/docs/surrealdb): Comprehensive documentation for SurrealDB
+- [SurrealQL Documentation](https://surrealdb.com/docs/surrealql): Documentation for SurrealDB's query language
+- [Surrealist Documentation](https://surrealist.com/docs/introduction): Documentation for Surrealist, database management interface
+- [Surreal Cloud Documentation](https://surrealdb.com/docs/cloud): Documentation for Surreal Cloud, the cloud-based version of SurrealDB
+- [JavaScript SDK Documentation](https://surrealdb.com/docs/javascript/introduction): Documentation for the JavaScript SDK
+- [Python SDK Documentation](https://surrealdb.com/docs/python/introduction): Documentation for the Python SDK
+- [Go SDK Documentation](https://surrealdb.com/docs/golang/introduction): Documentation for the Go SDK
+- [Rust SDK Documentation](https://surrealdb.com/docs/rust/introduction): Documentation for the Rust SDK
+
+
+
+
+
+
+
+
+- [SurrealDB CLI](https://surrealdb.com/docs/cli): Command line interface documentation
+- [HTTP Integration](https://surrealdb.com/docs/integration/http): Guide for using SurrealDB's HTTP API
+- []
+- [Access Control](https://surrealdb.com/docs/surrealql/statements/access): Security and permissions management
+
+## Examples
+
+- Database Operations:
+  - Creating and managing databases
+  - Defining tables and schemas
+  - Setting up relationships
+  - Querying and modifying data
+- Authentication:
+  - User management
+  - Role-based access control
+  - Token-based authentication
+- Real-time Features:
+  - Live queries
+  - Change feeds
+  - WebSocket subscriptions
+
+## Best Practices
+
+- Use appropriate authentication mechanisms for your use case
+- Implement proper access control policies
+- Design schemas with relationships in mind
+- Optimize queries for performance
+- Consider data modeling patterns that leverage SurrealDB's graph capabilities
+- Use transactions when maintaining data consistency is critical
+
+## Integration Options
+
+- Direct database integration
+- REST API usage
+- WebSocket connections
+- Language-specific SDKs
+- Framework integrations (where available)
diff --git a/package.json b/package.json
@@ -1,80 +1,81 @@
 {
-    "name": "docs.surrealdb.com",
-    "type": "module",
-    "version": "0.0.1",
-    "scripts": {
-        "dev": "astro dev",
-        "start": "astro dev",
-        "build": "bun run build-astro && bun run post-build",
-        "build-astro": "astro check && astro build",
-        "post-build": "bun run scripts/post-build.ts",
-        "preview": "astro preview",
-        "astro": "astro",
-        "serve": "bun scripts/serve.ts",
-        "ts": "tsc --watch",
-        "quality:check": "biome check .",
-        "quality:apply": "biome check . --write",
-        "quality:apply:unsafe": "biome check . --write --unsafe"
-    },
-    "dependencies": {
-        "@ark-ui/solid": "^3.13.0",
-        "@astrojs/check": "^0.9.4",
-        "@astrojs/mdx": "^3.1.9",
-        "@astrojs/sitemap": "^3.2.1",
-        "@astrojs/solid-js": "^4.4.3",
-        "@astrojs/tailwind": "^5.1.2",
-        "@codemirror/lang-sql": "^6.8.0",
-        "@codemirror/legacy-modes": "^6.4.2",
-        "@fig/lezer-bash": "^1.2.5",
-        "@iconify-icon/solid": "^2.1.1",
-        "@iconify-icons/fa6-regular": "^1.2.11",
-        "@iconify-icons/fa6-solid": "^1.2.13",
-        "@iconify-json/fa6-brands": "^1.2.2",
-        "@iconify-json/fa6-regular": "^1.2.2",
-        "@iconify-json/fa6-solid": "^1.2.2",
-        "@lezer/common": "^1.2.3",
-        "@lezer/go": "^1.0.0",
-        "@lezer/highlight": "^1.2.1",
-        "@lezer/javascript": "^1.4.19",
-        "@lezer/json": "^1.0.2",
-        "@lezer/php": "^1.0.2",
-        "@lezer/python": "^1.1.14",
-        "@lezer/rust": "^1.0.2",
-        "@lezer/yaml": "^1.0.3",
-        "@solid-primitives/scroll": "^2.0.23",
-        "@surrealdb/lezer": "^1.0.0-beta.16",
-        "@types/markdown-it": "^14.1.2",
-        "astro": "^4.16.13",
-        "astro-icon": "^1.1.2",
-        "clsx": "^2.1.1",
-        "gray-matter": "^4.0.3",
-        "hast-util-select": "^6.0.3",
-        "hast-util-to-html": "^9.0.3",
-        "hast-util-to-text": "^4.0.2",
-        "lezer-toml": "^1.0.0",
-        "markdown-it": "^14.1.0",
-        "remark": "^15.0.1",
-        "solid-devtools": "^0.30.1",
-        "solid-js": "^1.9.3",
-        "tailwind-merge": "^2.5.4",
-        "tailwindcss": "^3.4.15",
-        "typescript": "^5.6.3",
-        "unist-util-visit": "^5.0.0"
-    },
-    "devDependencies": {
-        "@biomejs/biome": "1.8.3",
-        "astro-compress": "^2.3.5",
-        "esbuild": "^0.23.1",
-        "hast-util-from-html": "^2.0.3",
-        "hast-util-to-string": "^3.0.1",
-        "hastscript": "^9.0.0",
-        "node-html-parser": "^6.1.13",
-        "rehype-autolink-headings": "^7.1.0",
-        "rehype-slug": "^6.0.0",
-        "remark-custom-heading-id": "^2.0.0",
-        "sass-embedded": "^1.81.0",
-        "tiny-glob": "^0.2.9"
-    },
-    "workspaces": ["plugins/*"],
-    "trustedDependencies": ["@biomejs/biome", "esbuild", "sharp"]
+  "name": "docs.surrealdb.com",
+  "type": "module",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "bun run build-astro && bun run post-build",
+    "build-astro": "astro check && astro build",
+    "post-build": "bun run scripts/post-build.ts",
+    "preview": "astro preview",
+    "astro": "astro",
+    "serve": "bun scripts/serve.ts",
+    "ts": "tsc --watch",
+    "quality:check": "biome check .",
+    "quality:apply": "biome check . --write",
+    "quality:apply:unsafe": "biome check . --write --unsafe"
+  },
+  "dependencies": {
+    "@ark-ui/solid": "^3.13.0",
+    "@astrojs/check": "^0.9.4",
+    "@astrojs/mdx": "^3.1.9",
+    "@astrojs/sitemap": "^3.2.1",
+    "@astrojs/solid-js": "^4.4.3",
+    "@astrojs/tailwind": "^5.1.2",
+    "@codemirror/lang-sql": "^6.8.0",
+    "@codemirror/legacy-modes": "^6.4.2",
+    "@fig/lezer-bash": "^1.2.5",
+    "@iconify-icon/solid": "^2.1.1",
+    "@iconify-icons/fa6-regular": "^1.2.11",
+    "@iconify-icons/fa6-solid": "^1.2.13",
+    "@iconify-json/fa6-brands": "^1.2.2",
+    "@iconify-json/fa6-regular": "^1.2.2",
+    "@iconify-json/fa6-solid": "^1.2.2",
+    "@lezer/common": "^1.2.3",
+    "@lezer/go": "^1.0.0",
+    "@lezer/highlight": "^1.2.1",
+    "@lezer/javascript": "^1.4.19",
+    "@lezer/json": "^1.0.2",
+    "@lezer/php": "^1.0.2",
+    "@lezer/python": "^1.1.14",
+    "@lezer/rust": "^1.0.2",
+    "@lezer/yaml": "^1.0.3",
+    "@solid-primitives/scroll": "^2.0.23",
+    "@surrealdb/lezer": "^1.0.0-beta.16",
+    "@types/markdown-it": "^14.1.2",
+    "astro": "^4.16.13",
+    "astro-icon": "^1.1.2",
+    "clsx": "^2.1.1",
+    "gray-matter": "^4.0.3",
+    "hast-util-select": "^6.0.3",
+    "hast-util-to-html": "^9.0.3",
+    "hast-util-to-text": "^4.0.2",
+    "lezer-toml": "^1.0.0",
+    "markdown-it": "^14.1.0",
+    "remark": "^15.0.1",
+    "solid-devtools": "^0.30.1",
+    "solid-js": "^1.9.3",
+    "tailwind-merge": "^2.5.4",
+    "tailwindcss": "^3.4.15",
+    "typescript": "^5.6.3",
+    "unist-util-visit": "^5.0.0",
+    "vite-plugin-llms": "^1.0.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.8.3",
+    "astro-compress": "^2.3.5",
+    "esbuild": "^0.23.1",
+    "hast-util-from-html": "^2.0.3",
+    "hast-util-to-string": "^3.0.1",
+    "hastscript": "^9.0.0",
+    "node-html-parser": "^6.1.13",
+    "rehype-autolink-headings": "^7.1.0",
+    "rehype-slug": "^6.0.0",
+    "remark-custom-heading-id": "^2.0.0",
+    "sass-embedded": "^1.81.0",
+    "tiny-glob": "^0.2.9"
+  },
+  "workspaces": ["plugins/*"],
+  "trustedDependencies": ["@biomejs/biome", "esbuild", "sharp"]
 }