generate llms full dynamically (#236)

* generate llms full dynamically

* added this to npm instead

* Update .github/workflows/docs.yml

Co-authored-by: Copilot <[email protected]>

* Update docs/scripts/extract-docs.js

Co-authored-by: Copilot <[email protected]>

* lint docs

* testing things

* fix linter

* Update docs/scripts/extract-docs.js

Co-authored-by: Copilot <[email protected]>

* Update docs/.vitepress/config.mts

Co-authored-by: Copilot <[email protected]>

* lint after copilot

* clean up after copilot

---------

Co-authored-by: Copilot <[email protected]>

Author: BrandonShar

.github/workflows/docs.yml

@@ -39,3 +39,14 @@ jobs:
       - name: Check formatting
         working-directory: ./docs
         run: npm run format:check
+
+      - name: Generate LLM-friendly documentation
+        working-directory: ./docs
+        run: node scripts/extract-docs.js
+
+      - name: Upload LLM docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: llm-docs
+          path: public/llms-full.txt
+          retention-days: 90

.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 /.cache/
 /Gemfile.lock
+.DS_Store
 
 /spec/dummy/db/*.sqlite3
 /spec/dummy/db/*.sqlite3-journal

docs/.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .vitepress/dist
 .vitepress/cache
+public/llms-full.txt

docs/.vitepress/config.mts

@@ -1,6 +1,12 @@
+import { execSync } from 'child_process'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
 import { defineConfig } from 'vitepress'
 import { tabsMarkdownPlugin } from './vitepress-plugin-tabs/tabsMarkdownPlugin'
 
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
 const title = 'Inertia Rails'
 const description = 'Documentation for Inertia.js Rails adapter'
 const site = 'https://inertia-rails.dev'
@@ -13,6 +19,22 @@ export default defineConfig({
 
   cleanUrls: true,
 
+  vite: {
+    plugins: [
+      {
+        name: 'generate-llm-docs',
+        buildStart() {
+          // Regenerate LLM docs before build
+          console.log('Regenerating LLM documentation...')
+          execSync('node scripts/extract-docs.js', {
+            cwd: join(__dirname, '..'),
+          })
+          console.log('LLM documentation updated!')
+        },
+      },
+    ],
+  },
+
   markdown: {
     config(md) {
       md.use(tabsMarkdownPlugin)

docs/package-lock.json

@@ -7,6 +7,7 @@
     "format": "prettier --write ."
   },
   "devDependencies": {
+    "gray-matter": "^4.0.3",
     "markdown-it-container": "^4.0.0",
     "prettier": "^3.3.3",
     "prettier-plugin-organize-imports": "^4.1.0",