From 109650a2276b78c943789c26a49b8296f9eeaade Mon Sep 17 00:00:00 2001 From: Jun Lee Date: Thu, 25 Sep 2025 15:31:01 +0100 Subject: [PATCH 1/2] Updating dashbutton deeplink for AI Search --- src/content/dash-routes/index.json | 2 +- src/content/docs/ai-search/get-started.mdx | 6 +++--- src/content/docs/ai-search/usage/rest-api.mdx | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/content/dash-routes/index.json b/src/content/dash-routes/index.json index 03a0bad24bcfae..860f0298617d63 100644 --- a/src/content/dash-routes/index.json +++ b/src/content/dash-routes/index.json @@ -301,7 +301,7 @@ }, { "name": "AI Search", - "deeplink": "/?to=/:account/ai/autorag", + "deeplink": "/?to=/:account/ai/ai-search", "parent": ["AI"] }, { diff --git a/src/content/docs/ai-search/get-started.mdx b/src/content/docs/ai-search/get-started.mdx index b92427bbfebe11..66e4b268379516 100644 --- a/src/content/docs/ai-search/get-started.mdx +++ b/src/content/docs/ai-search/get-started.mdx @@ -11,7 +11,7 @@ Description: Get started creating fully-managed, retrieval-augmented generation import { DashButton } from "~/components"; -AI Search (formerly AutoRAG) is Cloudflare’s managed search service. You can connect your data such as websites or unstructured content, and it automatically creates a continuously updating index that you can query with natural language in your applications or AI agents. +AI Search (formerly AutoRAG) is Cloudflare’s managed search service. You can connect your data such as websites or unstructured content, and it automatically creates a continuously updating index that you can query with natural language in your applications or AI agents. ## Prerequisite @@ -25,7 +25,7 @@ To create a new AI Search: 1. In the Cloudflare dashboard, go to the **AI Search** page. - + 2. Select **Create** 3. In Create a RAG, select **Get Started** @@ -55,7 +55,7 @@ Once indexing is complete, you can run your first query: ## 4. Add to your application -Once you are ready, go to **Connect** for instructions on how to connect AI Search to your application. +Once you are ready, go to **Connect** for instructions on how to connect AI Search to your application. There are multiple ways you can connect: diff --git a/src/content/docs/ai-search/usage/rest-api.mdx b/src/content/docs/ai-search/usage/rest-api.mdx index a67ce159f7b7f9..96cdaf3c6083b4 100644 --- a/src/content/docs/ai-search/usage/rest-api.mdx +++ b/src/content/docs/ai-search/usage/rest-api.mdx @@ -29,7 +29,7 @@ You need an API token with the `AI Search - Read` and `AI Search Edit` permissio 1. In the Cloudflare dashboard, go to the **AI Search** page. - + 2. Select your AI Search. 3. Select **Use AI Search** and then select **API**. From b3fe8e22a9715f517646b2e05adcd694e3545a1e Mon Sep 17 00:00:00 2001 From: Jun Lee Date: Thu, 25 Sep 2025 15:54:04 +0100 Subject: [PATCH 2/2] Updating style guide as well --- .../docs/style-guide/components/dash-button.mdx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/content/docs/style-guide/components/dash-button.mdx b/src/content/docs/style-guide/components/dash-button.mdx index 8f9e607083e413..7770e22ff3ce28 100644 --- a/src/content/docs/style-guide/components/dash-button.mdx +++ b/src/content/docs/style-guide/components/dash-button.mdx @@ -8,6 +8,21 @@ import AvailableDashRoutes from "~/components/AvailableDashRoutes.astro"; This component creates a [LinkButton](/style-guide/components/buttons/) that links to a Cloudflare dashboard deeplink. +While we recommend the use of `DashButton`, you can continue to use deeplinks (as a link, without the component), if necessary. + +:::note[Where routes are stored] +The list of available routes are generated by running a script that we manually trigger periodically. The script outputs the available paths in [`src/content/dash-routes/index.json`](https://github.com/cloudflare/cloudflare-docs/blob/production/src/content/dash-routes/index.json). + +The `DashButton` component then uses those routes to automatically generate the list of buttons on this page. The `DashButton` will fail to build if you edit the `url` prop to a route that is not listed in the `index.json` file. + +Additionally, each run of the script overwrites the previous `/dash-routes/index.json` file. If you edit the this file manually, it will be overwritten in the next run of the script. + +Therefore, only make manual changes to this file if both of the following are true: + +- The link is already live in the dashboard. +- The name-change is confirmed, and there's no (or little) chance of rollback. +::: + ## Import ```mdx live