Skip to content

Commit b57d5a3

Browse files
authored
[AI Search] Updating dashbutton deeplink for AI Search (#25424)
* Updating dashbutton deeplink for AI Search * Updating style guide as well
1 parent b2673ab commit b57d5a3

File tree

4 files changed

+20
-5
lines changed

4 files changed

+20
-5
lines changed

src/content/dash-routes/index.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@
301301
},
302302
{
303303
"name": "AI Search",
304-
"deeplink": "/?to=/:account/ai/autorag",
304+
"deeplink": "/?to=/:account/ai/ai-search",
305305
"parent": ["AI"]
306306
},
307307
{

src/content/docs/ai-search/get-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Description: Get started creating fully-managed, retrieval-augmented generation
1111

1212
import { DashButton } from "~/components";
1313

14-
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.
14+
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.
1515

1616
## Prerequisite
1717

@@ -25,7 +25,7 @@ To create a new AI Search:
2525

2626
1. In the Cloudflare dashboard, go to the **AI Search** page.
2727

28-
<DashButton url="/?to=/:account/ai/autorag" />
28+
<DashButton url="/?to=/:account/ai/ai-search" />
2929

3030
2. Select **Create**
3131
3. In Create a RAG, select **Get Started**
@@ -55,7 +55,7 @@ Once indexing is complete, you can run your first query:
5555

5656
## 4. Add to your application
5757

58-
Once you are ready, go to **Connect** for instructions on how to connect AI Search to your application.
58+
Once you are ready, go to **Connect** for instructions on how to connect AI Search to your application.
5959

6060
There are multiple ways you can connect:
6161

src/content/docs/ai-search/usage/rest-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You need an API token with the `AI Search - Read` and `AI Search Edit` permissio
2929

3030
1. In the Cloudflare dashboard, go to the **AI Search** page.
3131

32-
<DashButton url="/?to=/:account/ai/autorag" />
32+
<DashButton url="/?to=/:account/ai/ai-search" />
3333

3434
2. Select your AI Search.
3535
3. Select **Use AI Search** and then select **API**.

src/content/docs/style-guide/components/dash-button.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ import AvailableDashRoutes from "~/components/AvailableDashRoutes.astro";
88

99
This component creates a [LinkButton](/style-guide/components/buttons/) that links to a Cloudflare dashboard deeplink.
1010

11+
While we recommend the use of `DashButton`, you can continue to use deeplinks (as a link, without the component), if necessary.
12+
13+
:::note[Where routes are stored]
14+
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).
15+
16+
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.
17+
18+
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.
19+
20+
Therefore, only make manual changes to this file if both of the following are true:
21+
22+
- The link is already live in the dashboard.
23+
- The name-change is confirmed, and there's no (or little) chance of rollback.
24+
:::
25+
1126
## Import
1227

1328
```mdx live

0 commit comments

Comments
 (0)