Skip to content

[AI Search] Updating dashbutton deeplink for AI Search #25424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 25, 2025
Merged

[AI Search] Updating dashbutton deeplink for AI Search #25424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
109650a
Updating dashbutton deeplink for AI Search
Oxyjun Sep 25, 2025
b3fe8e2
Updating style guide as well
Oxyjun Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/dash-routes/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@
},
{
"name": "AI Search",
"deeplink": "/?to=/:account/ai/autorag",
"deeplink": "/?to=/:account/ai/ai-search",
Copy link
Contributor

@pedrosousa pedrosousa Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This change may be overwritten when we merge a new version of the dash routes file if it's not fixed in the source.

Copy link
Contributor Author

@Oxyjun Oxyjun Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @pedrosousa , that's a good point.

Hopefully it'll be picked up when the script is next run, as that's what the new Dashboard URL is.

This'll be an interim fix to make sure the link isn't broken.

Copy link
Contributor

@pedrosousa pedrosousa Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good!
Just be on the lookout for any inadvertent rollback.

"parent": ["AI"]
},
{
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/ai-search/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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

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

2. Select **Create**
3. In Create a RAG, select **Get Started**
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ai-search/usage/rest-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

2. Select your AI Search.
3. Select **Use AI Search** and then select **API**.
Expand Down
15 changes: 15 additions & 0 deletions src/content/docs/style-guide/components/dash-button.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading