docs: add property-specific anchors for API documentation (#93)

vonovak · vonovak · commit ba43e3947064 · 2026-02-07T22:10:16.000+01:00
diff --git a/docs/api/index.mdx b/docs/api/index.mdx
diff --git a/docs/buttons/google-logo-button.mdx b/docs/buttons/google-logo-button.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_class_name: sponsor-heart
+description: "GoogleLogoButton component following Google's official branding guidelines. For native apps only (renders null on web). Customizable size, style, and loading state."
 ---
 
 # GoogleLogoButton
diff --git a/docs/buttons/web.mdx b/docs/buttons/web.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_class_name: sponsor-heart
+description: "WebGoogleSigninButton component for web apps. Renders null in native apps. Supports size, shape, theme, and locale customization."
 ---
 
 # WebGoogleSigninButton
diff --git a/docs/config-doctor.md b/docs/config-doctor.md
@@ -2,6 +2,7 @@
 sidebar_label: Config doctor
 sidebar_position: 75
 sidebar_class_name: sponsor-heart
+description: "CLI tool to diagnose Android signing configuration issues and resolve DEVELOPER_ERROR."
 ---
 
 # Configuration Doctor
diff --git a/docs/errors.md b/docs/errors.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 60
+description: "Error handling guide. Covers isErrorWithCode helper, error codes (SIGN_IN_CANCELLED, NO_SAVED_CREDENTIAL_FOUND, PLAY_SERVICES_NOT_AVAILABLE, etc.), and best practices."
 ---
 
 # Error handling
diff --git a/docs/install.mdx b/docs/install.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+description: "Install @react-native-google-signin/google-signin. Covers paid (Universal Sign In) and free (Original) versions, requirements, and package manager setup."
 ---
 
 # Installation
diff --git a/docs/migrating.md b/docs/migrating.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 43
+description: "Migration guides: from Original to Universal Sign In module, and from the legacy JS API to the new API."
 ---
 
 # Migration guides
diff --git a/docs/one-tap.mdx b/docs/one-tap.mdx
@@ -2,6 +2,7 @@
 sidebar_position: 30
 sidebar_label: Universal Google sign in
 sidebar_class_name: sponsor-heart
+description: "Google's recommended Sign-In API for Android (Credential Manager), iOS/macOS (Google Sign-In SDK), and web. Covers configuration, sign-in flows, user data access, and token handling."
 ---
 
 # Universal sign in
diff --git a/docs/original.mdx b/docs/original.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 40
+description: "Legacy Google Sign-In module for Android and iOS. Consider migrating to Universal Sign In."
 ---
 
 # Original Google sign in
diff --git a/docs/security.mdx b/docs/security.mdx
@@ -2,6 +2,7 @@
 sidebar_position: 42
 sidebar_label: Advanced security
 sidebar_class_name: sponsor-heart
+description: "Advanced security features: custom nonce support on all platforms and App Check for iOS."
 ---
 
 import Banner from './_sponsorBanner.mdx';
diff --git a/docs/setting-up/android.md b/docs/setting-up/android.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+description: "Android setup guide for vanilla React Native apps (not Expo). Covers Google project configuration, linking, and Credential Manager setup."
 ---
 
 # Android setup guide
diff --git a/docs/setting-up/expo.md b/docs/setting-up/expo.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+description: "Expo setup guide. Covers config plugin setup and EAS Build configuration for Google Sign-In."
 ---
 
 # Expo setup
diff --git a/docs/setting-up/get-config-file.mdx b/docs/setting-up/get-config-file.mdx
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 15
 sidebar_label: Configuration
+description: "How to obtain webClientId, iOS clientId, and other configuration values from Google Cloud Console or Firebase. Required before platform setup."
 ---
 
 # Collecting configuration information
diff --git a/docs/setting-up/ios.md b/docs/setting-up/ios.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+description: "iOS setup guide for vanilla React Native apps (not Expo). Covers native module linking, URL schemes, and plist configuration."
 ---
 
 # iOS setup guide
diff --git a/docs/setting-up/web.mdx b/docs/setting-up/web.mdx
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 5
 sidebar_class_name: sponsor-heart
+description: "Web setup guide. Works with NextJS, Vite, and other web frameworks. Covers Google client ID configuration and script loading."
 ---
 
 # Web setup guide
diff --git a/docs/testing.md b/docs/testing.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 50
+description: "How to mock Google Sign-In in Jest tests for both the Universal and Original modules."
 ---
 
 # Testing
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -1,6 +1,7 @@
 ---
 sidebar_label: Troubleshooting
 sidebar_position: 70
+description: "Common issues and solutions for Android (DEVELOPER_ERROR, cancelled results) and iOS (missing profile data, URL schemes)."
 ---
 
 # FAQ / Troubleshooting
diff --git a/docs/web-support.mdx b/docs/web-support.mdx
@@ -2,6 +2,7 @@
 sidebar_position: 41
 sidebar_label: Web support
 sidebar_class_name: sponsor-heart
+description: "Web platform support. Works with NextJS, Vite, and other web frameworks without React Native Web dependency. Covers setup, rendering modes, and limitations."
 ---
 
 # Web support
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -87,17 +87,68 @@ const config: Config = {
     [
       'docusaurus-plugin-llms',
       {
-        // Enable both content cleaning options for optimal LLM output
         ignoreFiles: [
-          'other-libs**',
-          'original**', // not to confuse the two modules?
-          'screenshots**',
-          'license**',
-          'integration-notes**',
-          '**/buttons/native**',
+          'other-libs*',
+          'original*',
+          'screenshots*',
+          'screenshots/**',
+          'license*',
+          'integration-notes*',
+          '**/buttons/native*',
         ],
         fullContent: true,
+        excludeImports: false,
         removeDuplicateHeadings: true,
+        description:
+          'Google Sign-In for React Native and Expo apps (Android, iOS, macOS, web). Package: @react-native-google-signin/google-signin',
+        rootContent: `## Overview
+
+\`@react-native-google-signin/google-signin\` provides Google authentication for React Native and Expo apps.
+
+There are two modules:
+- **Universal Sign In** (recommended, [paid](https://universal-sign-in.com/#pricing)): Cross-platform API using Android Credential Manager and iOS Google Sign-In SDK. Module name: \`GoogleOneTapSignIn\`.
+- **Original Google Sign In** (free): Legacy API for Android and iOS only. Module name: \`GoogleSignin\`.
+
+## Quick start
+
+1. Install the package (see Installation)
+2. Collect configuration (see Configuration guide)
+3. Follow the setup guide for your platform (Expo, Android, iOS, or Web)
+4. Use the Universal Sign In API (see Universal sign in)
+
+## Docs`,
+        fullRootContent: `## Overview
+
+\`@react-native-google-signin/google-signin\` provides Google authentication for React Native and Expo apps on Android, iOS, macOS, and web.
+
+There are two modules:
+- **Universal Sign In** (recommended, [paid](https://universal-sign-in.com/#pricing)): Cross-platform API using Android Credential Manager and iOS Google Sign-In SDK. Module name: \`GoogleOneTapSignIn\`.
+- **Original Google Sign In** (free): Legacy API for Android and iOS only. Module name: \`GoogleSignin\`.
+
+Key concepts:
+- Call \`configure()\` once before any sign-in calls
+- \`webClientId\` is required for configuration (obtain from Google Cloud Console)
+- Use \`signIn()\` for returning users, \`createAccount()\` for new users
+- Use \`requestAuthorization()\` to request additional OAuth scopes
+- Handle errors with \`isErrorWithCode()\` helper`,
+        includeOrder: [
+          'install*',
+          '**/get-config-file*',
+          '**/expo*',
+          '**/setting-up/android*',
+          '**/setting-up/ios*',
+          '**/setting-up/web*',
+          'one-tap*',
+          'web-support*',
+          'security*',
+          '**/buttons/**',
+          'errors*',
+          'testing*',
+          'troubleshooting*',
+          'migrating*',
+          'config-doctor*',
+          'api/**',
+        ],
       },
     ],
     // [
@@ -221,7 +272,7 @@ const config: Config = {
         //   ],
         // },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} Vojtech Novak. Built with Docusaurus.`,
+      copyright: `Copyright © ${new Date().getFullYear()} <a href="https://universal-sign-in.com/">universal-sign-in.com</a>`,
     },
     prism: {
       theme: prismThemes.github,
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "startDG": "ENABLE_DOC_GEN=true docusaurus start",
     "start": "ENABLE_DOC_GEN=false docusaurus start",
-    "build": "docusaurus build",
+    "build": "docusaurus build && node scripts/clean-llm-files.mjs",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
@@ -37,7 +37,7 @@
     "docusaurus-plugin-typedoc": "^1.4.2",
     "prettier": "^3.7.4",
     "typedoc": "^0.28.15",
-    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-markdown": "^4.10.0",
     "typescript": "~5.9.3"
   },
   "browserslist": {
diff --git a/scripts/clean-llm-files.mjs b/scripts/clean-llm-files.mjs
@@ -0,0 +1,104 @@
+/**
+ * Post-build cleanup for LLM documentation files.
+ * Strips Docusaurus-specific syntax (JSX components, admonitions, etc.)
+ * that isn't useful for LLM consumption.
+ *
+ * Usage: node scripts/clean-llm-files.mjs
+ */
+
+import { readFileSync, writeFileSync } from "fs";
+import { join } from "path";
+
+const BUILD_DIR = join(import.meta.dirname, "..", "build");
+const FILES = ["llms.txt", "llms-full.txt"];
+
+/**
+ * Cleanups safe to apply everywhere (including inside code blocks).
+ */
+function cleanGlobal(content) {
+  return (
+    content
+      // Remove Docusaurus code block attributes (showLineNumbers, title)
+      .replace(
+        /^(```\w*)\s+(?:title="[^"]*"\s*)?(?:showLineNumbers\s*)?$/gm,
+        "$1",
+      )
+      // Collapse 3+ consecutive blank lines to 2
+      .replace(/\n{4,}/g, "\n\n\n")
+  );
+}
+
+/**
+ * Cleanups that must ONLY apply outside of fenced code blocks
+ * to avoid mangling code examples.
+ */
+function cleanProse(text) {
+  return (
+    text
+      // Remove Docusaurus theme imports
+      .replace(/^import .+ from '@theme\/.*';\n?/gm, "")
+      // Convert <TabItem label="..."> to a bold label, remove other Tabs markup
+      .replace(/<\/?Tabs[^>]*>\n?/g, "")
+      .replace(/<TabItem[^>]*label="([^"]*)"[^>]*>\n?/g, "**$1:**\n")
+      .replace(/<TabItem[^>]*>\n?/g, "")
+      .replace(/<\/TabItem>\n?/g, "")
+      // Remove <details>/<summary> (keep inner content)
+      .replace(/<details>\n?/g, "")
+      .replace(/<\/details>\n?/g, "")
+      .replace(/<summary>(.*?)<\/summary>\n?/g, "**$1**\n")
+      // Remove <Banner /> and similar self-closing Docusaurus JSX components
+      .replace(/<Banner\s*\/>\n?/g, "")
+      // Convert admonitions to blockquote labels
+      .replace(
+        /^:::(tip|warning|note|danger|important|info)\n?/gm,
+        (_, type) =>
+          `> **${type.charAt(0).toUpperCase() + type.slice(1)}**: `,
+      )
+      .replace(/^:::\n?/gm, "\n")
+      // Remove highlight markers that appear outside code blocks (e.g. in markdown)
+      .replace(/^\s*\/\/ highlight-(?:start|end|next-line)\n?/gm, "")
+      // Remove markdown comments
+      .replace(/^\[\/\/\]: # '.*?'\n?/gm, "")
+      // Remove image references (local paths, not useful for LLMs)
+      .replace(/^[ \t]*!\[.*?\]\(\/img\/.*?\)\n?/gm, "")
+      // Clean up JSX expressions like {'>='} to just the text
+      .replace(/\{'\s*(.*?)\s*'\}/g, "$1")
+  );
+}
+
+/**
+ * Split content into code-fenced and non-code-fenced segments,
+ * apply prose cleanup only to non-code segments, then reassemble.
+ */
+function cleanContent(content) {
+  // Split on code fences (``` with optional language identifier)
+  const parts = content.split(/^(```\w*.*$)/gm);
+  let insideCodeBlock = false;
+  const cleaned = parts.map((part) => {
+    if (/^```\w*/.test(part)) {
+      insideCodeBlock = !insideCodeBlock;
+      return part;
+    }
+    return insideCodeBlock ? part : cleanProse(part);
+  });
+
+  return cleanGlobal(cleaned.join(""));
+}
+
+for (const file of FILES) {
+  const filePath = join(BUILD_DIR, file);
+  try {
+    const content = readFileSync(filePath, "utf-8");
+    const cleaned = cleanContent(content);
+    writeFileSync(filePath, cleaned);
+    const reduction = (
+      ((content.length - cleaned.length) / content.length) *
+      100
+    ).toFixed(1);
+    console.log(
+      `Cleaned ${file}: ${content.length} -> ${cleaned.length} bytes (${reduction}% reduction)`,
+    );
+  } catch (err) {
+    console.error(`Error processing ${file}:`, err.message);
+  }
+}
diff --git a/src/components/HomepageFeatures/index.tsx b/src/components/HomepageFeatures/index.tsx
@@ -24,7 +24,7 @@ const FeatureList: FeatureItem[] = [
     description: (
       <>
         Thanks to the licensed version, the module is maintained, and comes with
-        detailed documentation.
+        detailed, <a href="/llms-full.txt">AI-friendly</a> docs.
       </>
     ),
   },
@@ -34,8 +34,8 @@ const FeatureList: FeatureItem[] = [
     Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
     description: (
       <>
-        Supports the New Architecture, and most of the features of the native
-        SDKs. Open an issue if something's missing!
+        Supports the New Architecture and covers the full breadth of the native
+        SDKs.
       </>
     ),
   },
diff --git a/yarn.lock b/yarn.lock
@@ -8324,7 +8324,7 @@ __metadata:
     react: "npm:^19.2.3"
     react-dom: "npm:^19.2.3"
     typedoc: "npm:^0.28.15"
-    typedoc-plugin-markdown: "npm:^4.9.0"
+    typedoc-plugin-markdown: "npm:^4.10.0"
     typescript: "npm:~5.9.3"
   languageName: unknown
   linkType: soft
@@ -15739,12 +15739,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"typedoc-plugin-markdown@npm:^4.9.0":
-  version: 4.9.0
-  resolution: "typedoc-plugin-markdown@npm:4.9.0"
+"typedoc-plugin-markdown@npm:^4.10.0":
+  version: 4.10.0
+  resolution: "typedoc-plugin-markdown@npm:4.10.0"
   peerDependencies:
     typedoc: 0.28.x
-  checksum: 10c0/12040bbff7bc7e4f777d06710e39421f8ebaaf706f4b8075536453f35bc86726c5ce743de0cc9c39ee1bdfc8611b2878a4cf4c83a493e0678fc640dd71fe97fc
+  checksum: 10c0/20c7bc8ef68bd90053649ce223d02d4aceefed675c09efb1740c7791fbc37c10a1e25d14647605484a198f0695312eb21119015616d91c73fe1d63df5e4fb061
   languageName: node
   linkType: hard
 
