Improve documentation discoverability for coding agents

documentation/docs/article/getting_started.md

@@ -1,5 +1,6 @@
 ---
 sidebar_position: 0
+description: Install playwright-ruby-client with a compatible Playwright driver and run a first Ruby browser automation script.
 ---
 
 # Getting started

documentation/docs/article/guides/launch_browser.md

@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+description: Launch Chromium, Firefox, or WebKit from Ruby and configure browser launch options.
 ---
 
 # Launch Browser

documentation/docs/article/guides/rails_integration_with_null_driver.md

@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+description: Use native Playwright APIs in Rails system tests while retaining Capybara only for test server lifecycle management.
 ---
 
 # Use Capybara without DSL

documentation/docusaurus.config.js

@@ -9,6 +9,37 @@ module.exports = {
   favicon: 'img/playwright-logo.svg',
   organizationName: 'YusukeIwaki', // Usually your GitHub org/user name.
   projectName: 'playwright-ruby-client', // Usually your repo name.
+  plugins: [
+    [
+      'docusaurus-plugin-llms',
+      {
+        generateLLMsTxt: true,
+        generateLLMsFullTxt: false,
+        generateMarkdownFiles: true,
+        docsDir: 'docs',
+        title: 'playwright-ruby-client',
+        description: 'Ruby client for Playwright, including API reference and integration guides.',
+        rootContent: `This is a community-maintained Ruby client for Playwright.
+
+Important usage notes:
+- The gem does not include the Playwright driver or its downloader. Install a compatible Playwright package separately and pass its CLI path to \`Playwright.create\`.
+- Determine the compatible Playwright version from \`Playwright::COMPATIBLE_PLAYWRIGHT_VERSION\`; do not assume the newest npm package is compatible.
+- Use playwright-ruby-client for native Playwright APIs. Use capybara-playwright-driver when compatibility with the Capybara DSL is more important.
+- Prefer the Ruby examples and signatures in this documentation over examples for other Playwright language bindings.`,
+        includeOrder: [
+          'article/getting_started.md',
+          'article/guides/**/*.md',
+          'api/playwright.md',
+          'api/**/*.md',
+          'article/api_coverage.mdx',
+        ],
+        includeUnmatchedLast: true,
+        ignoreFiles: ['include/**'],
+        excludeImports: true,
+        removeDuplicateHeadings: true,
+      },
+    ],
+  ],
   themeConfig: {
     image: 'img/playwright-ruby-client.png',
     navbar: {

documentation/package.json

@@ -35,5 +35,8 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "devDependencies": {
+    "docusaurus-plugin-llms": "0.5.0"
   }
 }