Getting Started
Core Features
How-To Guides
Integrations
Troubleshooting
The Site Search feature allows users to quickly find relevant information across your documentation. It provides a responsive search interface that processes queries against your chosen search provider, returning categorized results to help users navigate your site efficiently.
When a user types into the search bar, the system processes the request by communicating with your configured search provider. To ensure a smooth experience, the search is "debounced"—meaning it waits a short moment after the user stops typing before triggering the query, which prevents unnecessary network traffic and improves performance.
You can customize the behavior of your search experience by adjusting settings during the initial setup.
Tip
If your site has a very large amount of content, increasing the delayMs value can help reduce the number of requests sent to your search provider while the user is still typing.
Important
Always prefer server-side search implementations whenever possible. Relying on client-side search with direct API keys can expose sensitive credentials in the browser, which is a security risk.
Warning
If you are migrating from older configurations, be aware that many specific search types are being deprecated in favor of a unified client-based approach. Ensure you check your implementation to see if you are using the modern client interface instead of the older type property.
Note
If you notice the search interface acting inconsistently, ensure that you have provided the necessary dependency arrays if you are using custom client configurations. This ensures the search results refresh properly when parameters change.
If you encounter issues where the search box does not return results or behaves unexpectedly, verify that your client is properly initialized. If you are using a custom client, ensure that any external dependencies are explicitly defined so the system knows when to re-trigger the search process.
If you continue to see errors or if the search results do not match your expectations, contact your technical administrator to verify the search provider's configuration. Ensure that your documentation structure is correctly indexed by your chosen provider, as missing pages or incorrect site maps can lead to empty or inaccurate search results.