From e64046fc101fbc251ab124104d1f7c848d503067 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 30 Jul 2025 03:02:33 +0000 Subject: [PATCH 1/2] Update search.mdx based on issue #231 --- fern/products/docs/pages/customization/search.mdx | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/fern/products/docs/pages/customization/search.mdx b/fern/products/docs/pages/customization/search.mdx index 450348a73..e924be330 100644 --- a/fern/products/docs/pages/customization/search.mdx +++ b/fern/products/docs/pages/customization/search.mdx @@ -16,14 +16,23 @@ It includes built-in filters that let users refine their searches by content typ - **Guides:** Filters results by non-API reference documentation. - **Changelog:** Filters results by changelog updates. -If you are using the AI Search feature, the search box also functions as your site’s chat window. +If you are using the AI Search feature, the search box also functions as your site's chat window. **Note:** If an article includes the `nofollow` or `noindex` [frontmatter](/learn/docs/content/frontmatter#indexing-properties), it will not be indexed by Algolia DocSearch and won't appear in search results. +## Using Fern's Algolia in your application + +If you want to integrate Fern documentation search into your own application, you can request Algolia credentials from the Fern team. These credentials will allow you to directly query the same search index that powers your Fern documentation site. + +To get started: +1. Contact the Fern team to request Algolia credentials +2. Use the provided credentials to initialize the Algolia client in your application +3. Query the search index using Algolia's API + ## Using an alternative search You can override Fern's search with your own solution. [Here](https://github.com/deepgram/deepgram-docs/blob/main/fern/assets/component.js) is an example of custom JavaScript a customer used to replace the default search with their own implementation and additional features. -To learn more, see [Custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript). +To learn more, see [Custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript). \ No newline at end of file From e6a5ca60a6c60e1bfcf18f68be52a038bf00396e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 30 Jul 2025 03:02:34 +0000 Subject: [PATCH 2/2] Update sdk-snippets.mdx based on issue #231 --- .../docs/pages/api-references/sdk-snippets.mdx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/fern/products/docs/pages/api-references/sdk-snippets.mdx b/fern/products/docs/pages/api-references/sdk-snippets.mdx index f0aa18021..e8c580fcc 100644 --- a/fern/products/docs/pages/api-references/sdk-snippets.mdx +++ b/fern/products/docs/pages/api-references/sdk-snippets.mdx @@ -117,3 +117,18 @@ Merge.dev is an example of a Fern customer that uses the Snippets API to bring P ## Endpoint request and response snippets Looking for information on generating API endpoint request and response snippets? See our documentation on [Endpoint Request Snippets](/learn/docs/content/components/request-snippet) and [Endpoint Response Snippets](/learn/docs/content/components/response-snippet). + +## Search Integration + +You can integrate Fern's documentation search functionality into your own application using our Algolia credentials. Contact us to get access to Algolia credentials specific to your documentation. This allows you to: + +- Search through your Fern-generated documentation programmatically +- Integrate documentation search into your dashboard or application +- Access the same search index used on your Fern documentation site + +To get started with search integration: +1. Request Algolia credentials from the Fern team +2. Use the provided credentials to initialize the Algolia client in your application +3. Query the search index to retrieve documentation results + +The search functionality uses the same Algolia index that powers the search on your Fern documentation site, ensuring consistent results across platforms. \ No newline at end of file