feat: support for llms.txt and llms-full.txt (#497)

* feat: support for controlled RangePicker

* feat: add support for llms.txt and llms-full.txt

* chore: fix doc usage, examples and redundant tags

Author: rohanchkrabrty

apps/www/next.config.mjs

@@ -1,4 +1,4 @@
-import { createMDX } from "fumadocs-mdx/next";
+import { createMDX } from 'fumadocs-mdx/next';
 
 const withMDX = createMDX();
 
@@ -10,16 +10,28 @@ const config = {
     // Dangerously allow production builds to successfully complete even if
     // your project has type errors.
     // !! WARN !!
-    ignoreBuildErrors: true,
+    ignoreBuildErrors: true
   },
   eslint: {
     // Warning: This allows production builds to successfully complete even if
     // your project has ESLint errors.
-    ignoreDuringBuilds: true,
+    ignoreDuringBuilds: true
   },
   experimental: {
-    optimizePackageImports: ["shiki"],
+    optimizePackageImports: ['shiki']
   },
+  async rewrites() {
+    return [
+      {
+        source: '/docs/:path*.mdx',
+        destination: '/llms.mdx/:path*'
+      },
+      {
+        source: '/docs/:path*.md',
+        destination: '/llms.mdx/:path*'
+      }
+    ];
+  }
 };
 
 export default withMDX(config);

apps/www/package.json

@@ -16,7 +16,7 @@
     "fumadocs-core": "^14.7.7",
     "fumadocs-docgen": "^1.3.8",
     "fumadocs-mdx": "^11.5.6",
-    "fumadocs-typescript": "^3.1.0",
+    "fumadocs-typescript": "^4.0.6",
     "fumadocs-ui": "^14.7.7",
     "lucide-react": "^0.477.0",
     "next": "14.2.5",
@@ -25,9 +25,14 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-live": "^4.1.8",
+    "remark": "^15.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-mdx": "^3.1.0",
+    "unist-util-visit": "^5.0.0",
     "zod": "^3.24.2"
   },
   "devDependencies": {
+    "@types/mdast": "^4.0.4",
     "@types/mdx": "^2.0.13",
     "@types/node": "22.13.4",
     "@types/prettier": "^3.0.0",

apps/www/source.config.ts

@@ -1,23 +1,25 @@
+import { TagSchema } from '@/lib/types';
+import { remarkInstall } from 'fumadocs-docgen';
 import {
-  defineDocs,
   defineConfig,
-  frontmatterSchema,
-} from "fumadocs-mdx/config";
-import { remarkInstall } from "fumadocs-docgen";
-import { remarkAutoTypeTable } from "fumadocs-typescript";
-import { TagSchema } from "@/lib/types";
+  defineDocs,
+  frontmatterSchema
+} from 'fumadocs-mdx/config';
+import { createGenerator, remarkAutoTypeTable } from 'fumadocs-typescript';
+
+const generator = createGenerator();
 
 export const docs = defineDocs({
-  dir: "src/content/docs",
+  dir: 'src/content/docs',
   docs: {
     schema: frontmatterSchema.extend({
-      tag: TagSchema,
-    }),
-  },
+      tag: TagSchema
+    })
+  }
 });
 
 export default defineConfig({
   mdxOptions: {
-    remarkPlugins: [remarkInstall, remarkAutoTypeTable],
-  },
+    remarkPlugins: [remarkInstall, [remarkAutoTypeTable, { generator }]]
+  }
 });

apps/www/src/app/(llms)/llms-full.txt/route.ts

@@ -0,0 +1,14 @@
+import { getLLMText } from '@/lib/ai';
+import { docs } from '@/lib/source';
+
+// cached forever
+export const revalidate = false;
+
+export async function GET() {
+  const scan = docs.getPages().map(getLLMText);
+  const scanned = await Promise.all(scan);
+  const header =
+    '<SYSTEM>This is the full developer documentation for Apsara Design System.</SYSTEM>';
+
+  return new Response(header + '\n\n' + scanned.join('\n\n***\n\n'));
+}

apps/www/src/app/(llms)/llms.mdx/[[...slug]]/route.ts

@@ -0,0 +1,23 @@
+import { getLLMText } from '@/lib/ai';
+import { docs } from '@/lib/source';
+import { notFound } from 'next/navigation';
+import { type NextRequest, NextResponse } from 'next/server';
+
+// cached forever
+export const revalidate = false;
+
+export async function GET(
+  _req: NextRequest,
+  { params }: { params: Promise<{ slug?: string[] }> }
+) {
+  const { slug } = await params;
+  const page = docs.getPage(slug);
+
+  if (!page) notFound();
+
+  return new NextResponse(await getLLMText(page));
+}
+
+export function generateStaticParams() {
+  return docs.generateParams();
+}

apps/www/src/app/(llms)/llms.txt/route.ts

@@ -0,0 +1,24 @@
+import { docs } from '@/lib/source';
+
+// cached forever
+export const revalidate = false;
+
+export async function GET() {
+  const scanned: string[] = [];
+  scanned.push('# Apsara Design System Documentation for LLMs');
+  const map = new Map<string, string[]>();
+
+  for (const page of docs.getPages()) {
+    const dir = page.slugs[0] ?? 'root';
+    const list = map.get(dir) ?? [];
+    list.push(`- [${page.data.title}](${page.url}): ${page.data.description}`);
+    map.set(dir, list);
+  }
+
+  for (const [key, value] of map) {
+    scanned.push(`## ${key}`);
+    scanned.push(value.join('\n'));
+  }
+
+  return new Response(scanned.join('\n\n'));
+}

apps/www/src/content/docs/components/amount/index.mdx

@@ -22,11 +22,7 @@ import {
 ## Usage
 
 ```tsx
-import { Amount } from '@raystack/apsara/v1'
-
-<Amount value={1299} />
-<Amount value={1299} currency="EUR" locale="fr-FR" />
-<Amount value="999999999999999" />
+import { Amount } from '@raystack/apsara'
 ```
 
 ## Amount Props
@@ -71,4 +67,4 @@ For numbers larger than JavaScript's safe integer limit (2^53 - 1), pass the val
 
 ### With Text
 
-<Demo data={withTextDemo} /> 
+<Demo data={withTextDemo} />

apps/www/src/content/docs/components/announcement-bar/demo.ts

@@ -1,23 +1,23 @@
-"use client";
+'use client';
 
-import { getPropsString } from "@/lib/utils";
+import { getPropsString } from '@/lib/utils';
 
 export const getCode = (props: any) => {
   return `<AnnouncementBar${getPropsString(props)}/>`;
 };
 
 export const playground = {
-  type: "playground",
+  type: 'playground',
   controls: {
     variant: {
-      type: "select",
-      options: ["normal", "error", "gradient"],
-      defaultValue: "normal",
+      type: 'select',
+      options: ['normal', 'error', 'gradient'],
+      defaultValue: 'normal'
     },
-    text: { type: "text", initialValue: "We have introduced a new feature" },
-    leadingIcon: { type: "icon", defaultValue: "" },
-    actionLabel: { type: "text", initialValue: "Read More" },
-    actionIcon: { type: "icon", defaultValue: "" },
+    text: { type: 'text', initialValue: 'We have introduced a new feature' },
+    leadingIcon: { type: 'icon', defaultValue: '' },
+    actionLabel: { type: 'text', initialValue: 'Read More' },
+    actionIcon: { type: 'icon', defaultValue: '' }
   },
-  getCode,
+  getCode
 };

apps/www/src/content/docs/components/announcement-bar/index.mdx

@@ -15,6 +15,12 @@ import {
 
 <Demo data={playground} />
 
+## Usage
+
+```tsx
+import { AnnouncementBar } from '@raystack/apsara'
+```
+
 ## Announcement Bar Props
 
 <auto-type-table path="./props.ts" name="AnnouncementBarProps" />

apps/www/src/content/docs/components/avatar/index.mdx

@@ -15,11 +15,17 @@ import {
 
 <Demo data={playground} />
 
+## Usage
+
+```tsx
+import { Avatar, AvatarGroup, getAvatarColor } from '@raystack/apsara'
+```
+
 ## Avatar Props
 
 <auto-type-table path="./props.ts" name="AvatarProps" />
 
-## Avatar Group Props
+## AvatarGroup Props
 
 <auto-type-table path="./props.ts" name="AvatarGroupProps" />