docs: enable llms.txt for docs (#976)

## 📜 Description

Added generation of `llms.txt`.

## 💡 Motivation and Context

In reality people already use less and less classic search and more and
more trust to LLMs. However current LLMs struggle to index classic
websites and unofficial standard is usage of `llms.txt` - markdown files
that contains documentation.

To continuously generate llms files I decided to use a special plugin
that does. Maybe in future I'll switch to official docusaurus plugin,
but now let's not waste time and implement something to make docs LLMs
friendly.

## 📢 Changelog

<!-- High level overview of important changes -->
<!-- For example: fixed status bar manipulation; added new types
declarations; -->
<!-- If your changes don't affect one of platform/language below - then
remove this platform/language -->

### Docs

- continuously generate `llms.txt`;
- added patch-package;
- fixed broken anchors;

## 🤔 How Has This Been Tested?

Preview will not have LLMs integration (for now), so the only way to
test is to merge it and verify deploy.

## 📸 Screenshots (if appropriate):

<img width="266" alt="image"
src="https://github.com/user-attachments/assets/4e26ca9f-1882-4440-9158-8534a05f8b64"
/>

## 📝 Checklist

- [x] CI successfully passed
- [x] I added new mocks and corresponding unit-tests if library API was
changed

Author: kirillzyusko

cspell.json

@@ -155,7 +155,9 @@
     "HKLM",
     "xcassets",
     "appiconset",
-    "taskdefs"
+    "taskdefs",
+    "llms",
+    "signalwire"
   ],
   "ignorePaths": [
     "node_modules",

docs/docs/guides/interactive-keyboard.mdx

@@ -39,7 +39,7 @@ First of all let's consider a simple example and layout for typical chat applica
 
 ### Adding `KeyboardGestureArea`
 
-To make interactive dismissing work on Android we need to add `KeyboardGestureArea` view. This view will track all gestures and will control the keyboard positioning. To customize the way how the keyboard will be dismissed you can specify `interpolator` [prop](../api/keyboard-gesture-area.md#interpolator).
+To make interactive dismissing work on Android we need to add `KeyboardGestureArea` view. This view will track all gestures and will control the keyboard positioning. To customize the way how the keyboard will be dismissed you can specify `interpolator` [prop](../api/keyboard-gesture-area.md#interpolator-).
 
 In order to recognize all gestures on a `ScrollView` we need to wrap a `ScrollView` within `KeyboardGestureArea`:
 

docs/docusaurus.config.js

@@ -107,6 +107,24 @@ const config = {
       }),
     ],
   ],
+  plugins: [
+    [
+      "@signalwire/docusaurus-plugin-llms-txt",
+      {
+        // Plugin options
+        depth: 3,
+        siteTitle: "react-native0keyboard-controller",
+        siteDescription:
+          "Documentation for react-native-keyboard-controller. Package that allows to control each frame of keyboard movement in react native.",
+        content: {
+          includeBlog: true,
+          includePages: true,
+          excludeRoutes: ["**/docs/1.*/**"],
+          enableMarkdownFiles: true,
+        },
+      },
+    ],
+  ],
 
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */

docs/package.json

@@ -13,12 +13,14 @@
     "https": "HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem docusaurus start",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typescript": "tsc"
+    "typescript": "tsc",
+    "postinstall": "patch-package"
   },
   "dependencies": {
     "@docusaurus/core": "3.4.0",
     "@docusaurus/preset-classic": "3.4.0",
     "@mdx-js/react": "^3.0.0",
+    "@signalwire/docusaurus-plugin-llms-txt": "^1.0.1",
     "clsx": "^2.0.0",
     "lottie-react": "^2.4.0",
     "prism-react-renderer": "^2.3.0",
@@ -34,6 +36,7 @@
     "@playwright/test": "^1.46.0",
     "cheerio": "^1.0.0-rc.12",
     "markdownlint-cli2": "^0.12.1",
+    "patch-package": "^8.0.0",
     "typescript": "^5.2.2"
   },
   "browserslist": {

docs/patches/@signalwire+docusaurus-plugin-llms-txt+1.0.1.patch

@@ -0,0 +1,13 @@
+diff --git a/node_modules/@signalwire/docusaurus-plugin-llms-txt/lib/processing/route-processor.js b/node_modules/@signalwire/docusaurus-plugin-llms-txt/lib/processing/route-processor.js
+index 9c92f64..11d3f6f 100644
+--- a/node_modules/@signalwire/docusaurus-plugin-llms-txt/lib/processing/route-processor.js
++++ b/node_modules/@signalwire/docusaurus-plugin-llms-txt/lib/processing/route-processor.js
+@@ -27,7 +27,7 @@ async function processSingleRoute(route, cachedRoute, config, directories, logge
+         return {};
+     }
+     try {
+-        const fullHtmlPath = path.join(directories.docsDir, cachedRoute.htmlPath);
++        const fullHtmlPath = path.join(directories.docsDir, cachedRoute.htmlPath.replace("react-native-keyboard-controller/", "").replace("/index.html", ".html"));
+         const effectiveConfig = getEffectiveConfigForRoute(route.path, config);
+         const doc = await processHtmlFileWithContext(fullHtmlPath, route.path, effectiveConfig, directories.mdOutDir, logger, siteUrl, outDir);
+         if (doc) {

docs/versioned_docs/version-1.16.0/guides/interactive-keyboard.mdx

@@ -39,7 +39,7 @@ First of all let's consider a simple example and layout for typical chat applica
 
 ### Adding `KeyboardGestureArea`
 
-To make interactive dismissing work on Android we need to add `KeyboardGestureArea` view. This view will track all gestures and will control the keyboard positioning. To customize the way how the keyboard will be dismissed you can specify `interpolator` [prop](../api/keyboard-gesture-area.md#interpolator).
+To make interactive dismissing work on Android we need to add `KeyboardGestureArea` view. This view will track all gestures and will control the keyboard positioning. To customize the way how the keyboard will be dismissed you can specify `interpolator` [prop](../api/keyboard-gesture-area.md#interpolator-).
 
 In order to recognize all gestures on a `ScrollView` we need to wrap a `ScrollView` within `KeyboardGestureArea`:
 

docs/versioned_docs/version-1.17.0/guides/interactive-keyboard.mdx

@@ -39,7 +39,7 @@ First of all let's consider a simple example and layout for typical chat applica
 
 ### Adding `KeyboardGestureArea`
 
-To make interactive dismissing work on Android we need to add `KeyboardGestureArea` view. This view will track all gestures and will control the keyboard positioning. To customize the way how the keyboard will be dismissed you can specify `interpolator` [prop](../api/keyboard-gesture-area.md#interpolator).
+To make interactive dismissing work on Android we need to add `KeyboardGestureArea` view. This view will track all gestures and will control the keyboard positioning. To customize the way how the keyboard will be dismissed you can specify `interpolator` [prop](../api/keyboard-gesture-area.md#interpolator-).
 
 In order to recognize all gestures on a `ScrollView` we need to wrap a `ScrollView` within `KeyboardGestureArea`: