Add llms.txt generation for LLM-friendly docs (#920)

* Add llms.txt and llms-full.txt generation for LLM-friendly docs

Add a build script that generates llms.txt (lightweight index) and
llms-full.txt (full documentation content) from the Starlight doc
sources. These files follow the llms.txt specification, making the
documentation easily consumable by LLMs and indexable by services
like Context7 with minimal token usage.

- llms.txt: structured index with title, description, and URL per page
- llms-full.txt: all doc content as clean markdown (MDX/HTML stripped)
- Runs automatically before each build via package.json scripts

https://claude.ai/code/session_01Jj2MZELm7URFgydFbwwA8m

* Use starlight-llms-txt plugin and enable Starlight in production

Replace the custom build script with the purpose-built
starlight-llms-txt plugin, which generates llms.txt, llms-full.txt,
and llms-small.txt from the rendered Starlight documentation at build
time. This makes the docs easily accessible for LLMs and indexable by
services like Context7 with minimal token usage.

- Remove production guard so Starlight builds docs in all environments
- Add starlight-llms-txt plugin with RocketSim project name/description
- Remove custom generate-llms-txt.mjs script (replaced by plugin)
- Revert package.json build script and .gitignore changes

https://claude.ai/code/session_01Jj2MZELm7URFgydFbwwA8m

* fix: render raw content

* feat: postprocess llms.txt files

* fix: llms best practises

* fix: remove images in the small llms.txt variant only

* fix: formatter

---------

Co-authored-by: Claude <noreply@anthropic.com>

Author: ngnijland

docs/astro.config.ts

@@ -5,8 +5,10 @@ import mdx from "@astrojs/mdx";
 import AutoImport from "astro-auto-import";
 import tailwindcss from "@tailwindcss/vite";
 import starlight from "@astrojs/starlight";
+import starlightLlmsTxt from "starlight-llms-txt";
 
 import sitemap from "@astrojs/sitemap";
+import { llmsTxtPostProcess } from "./src/integrations/llms-txt-post-process";
 
 import config from "./src/config/config.json";
 
@@ -41,6 +43,14 @@ export default defineConfig({
       ],
     }),
     starlight({
+      plugins: [
+        starlightLlmsTxt({
+          projectName: "RocketSim",
+          description:
+            "RocketSim enhances the iOS Simulator with features for capturing screenshots and recordings, comparing designs, testing push notifications, deep links, location simulation, network speed control, accessibility toggles, and more.",
+          rawContent: true,
+        }),
+      ],
       title: "RocketSim Docs",
       disable404Route: true,
       logo: {
@@ -132,5 +142,6 @@ export default defineConfig({
       ],
     }),
     mdx(),
+    llmsTxtPostProcess(),
   ],
 });

docs/package-lock.json

@@ -25,7 +25,8 @@
     "marked": "^16.4.1",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "react-icons": "^5.5.0"
+    "react-icons": "^5.5.0",
+    "starlight-llms-txt": "^0.7.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.6",

docs/package.json

@@ -11,7 +11,7 @@ RocketSim’s General app actions window pane provides access to all kinds of fe
 
 ![CleanShot 2025-01-21 at 14.06.26@2x.png](./general-app-actions/cleanshot_2025-01-21_at_14.06.262x.png)
 
-Quickly test your app in any supported locale or specific timezone. You can read more about this feature here: [\*\*Localization testing in Xcode](https://www.avanderlee.com/xcode/localization-testing-in-xcode/).\*\* This feature is demonstrated in the following YouTube video:
+Quickly test your app in any supported locale or specific timezone. You can read more about this feature here: [**Localization testing in Xcode**](https://www.avanderlee.com/xcode/localization-testing-in-xcode/). This feature is demonstrated in the following YouTube video:
 
 <Youtube id="zukRdke1cP8" title="Localization Testing in Xcode" />
 
@@ -25,15 +25,15 @@ When working on features like Calendar access, it can be useful to quickly grant
 
 ![CleanShot 2025-01-21 at 14.08.14@2x.png](./general-app-actions/cleanshot_2025-01-21_at_14.08.142x.png)
 
-Directories important to your app are listed in logical order. Each directory has its purpose and I encourage you to read my detailed article if you want to know more: [\*\*Xcode Simulator Directories Exploration](https://www.avanderlee.com/xcode/simulator-directories-access/).\*\*
+Directories important to your app are listed in logical order. Each directory has its purpose and I encourage you to read my detailed article if you want to know more: [**Xcode Simulator Directories Exploration**](https://www.avanderlee.com/xcode/simulator-directories-access/).
 
 ## User Defaults
 
 By selecting either the Standard or Group User Defaults you’ll be able to monitor or edit defaults using the User Defaults Editor:
 
 ![User Defaults Editor.png](./general-app-actions/user_defaults_editor.png)
 
-You can read more about this in my dedicated article: [\*\*User Defaults reading and writing in Swift](https://www.avanderlee.com/swift/user-defaults-preferences/).\*\* Or watch the demo video on YouTube:
+You can read more about this in my dedicated article: [**User Defaults reading and writing in Swift**](https://www.avanderlee.com/swift/user-defaults-preferences/). Or watch the demo video on YouTube:
 
 <Youtube id="zTbQck3ofcc" title="User Defaults Editor Demo" />
 

docs/src/content/docs/docs/features/app-actions/general-app-actions.mdx

@@ -12,7 +12,7 @@ It's essential to test your app in bad networking conditions during app developm
 
 RocketSim’s Network Speed Control allows you to test your app for poor connections within the Simulator. The best thing of all: your Mac’s internet connection stays working, so you can still access ChatGPT or Stack Overflow while developing support.
 
-I encourage you to read my article [\*\*Optimizing your app for Network Reachability](https://www.avanderlee.com/swift/optimizing-network-reachability/)\*\* to prepare your app for bad networking conditions using RocketSim.
+I encourage you to read my article [**Optimizing your app for Network Reachability**](https://www.avanderlee.com/swift/optimizing-network-reachability/) to prepare your app for bad networking conditions using RocketSim.
 
 ## FAQ
 

docs/src/content/docs/docs/features/app-actions/network-speed-control-and-simulator-airplane-mode.mdx

@@ -7,7 +7,7 @@ Monitoring whether a User Defaults entry updates after a specific action or chan
 
 <Youtube id="zTbQck3ofcc" title="User Defaults Editor" />
 
-You can read more about this in my dedicated article: [\*\*User Defaults reading and writing in Swift](https://www.avanderlee.com/swift/user-defaults-preferences/).\*\*
+You can read more about this in my dedicated article: [**User Defaults reading and writing in Swift**](https://www.avanderlee.com/swift/user-defaults-preferences/).
 
 ### How can I add values to the User Defaults?
 

docs/src/content/docs/docs/features/app-actions/user-defaults-editor.mdx

@@ -9,7 +9,7 @@ RocketSim allows you to customize the status bar of the iOS Simulator.
 
 You might or might not have noticed, but all of Apple’s devices have the status bar time set to 09:41. Here’s an image from the iPhone product page as an example:
 
-![](./https:/)
+![Screenshot of iPhone product page](./statusbar-appearance/status_bar_override_9_41-1024x416.jpg)
 
 [That time used to be 9:42](https://www.businessinsider.com/iphone-ad-942-2012-2), matching the time of January 9th, 2007 when Steve Jobs announced the first first iPhone. Around 42 minutes into his keynote he mentioned: