Skip to content

AI Search update how to tutorials#31893

Open
aninibread wants to merge 3 commits into
productionfrom
anni/ai-search-how-tos
Open

AI Search update how to tutorials#31893
aninibread wants to merge 3 commits into
productionfrom
anni/ai-search-how-tos

Conversation

@aninibread

Copy link
Copy Markdown
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review

⚠️ 8 warnings, 💡 4 suggestions found in commit 06d2bb3.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

Warnings (1)
File Issue
ai-search/configuration/indexing/syncing.mdx line 35 Cooldown period conflicts with published release notes — The new text states sync jobs can be triggered at most once every 30 seconds, but the release notes entry for 2025-07-08 states the cooldown was reduced to 3 minutes. Fix: Verify the current cooldown limit with the product team and align the docs: update this sentence if the cooldown is 3 minutes, or update the release notes if the limit was changed to 30 seconds.

Conventions

Checks PR title, description, and redirect checklist.

Warnings (2)
File Issue
PR Description explains the work — The PR description contains only the unfilled template with no Summary content. Fix: Fill in the Summary section to explain what changes this PR makes.
PR Scope accuracy — The title says the PR updates AI Search how-to tutorials, but the description does not describe any of the changes. Fix: Account for the AI Search tutorial updates in the description so it reflects the PR's scope.

Style Guide Review

Warnings (5)
File Issue
ai-search/how-to/add-search-to-your-website.mdx line 30 Directional words — Line uses below (follow the steps below) Fix: Replace with a direct reference, e.g. follow the next steps
ai-search/how-to/add-search-to-your-website.mdx line 36 PackageManagers for npx commands — Bare ```sh block contains only npx wrangler ai-search create ... Fix: Use <PackageManagers type="exec" pkg="wrangler" args="ai-search create my-search --type web-crawler --source <YOUR_DOMAIN>" />
ai-search/how-to/add-search-to-your-website.mdx line 44 PackageManagers for npx commands — Bare ```sh block contains only npx wrangler ai-search stats my-search Fix: Use <PackageManagers type="exec" pkg="wrangler" args="ai-search stats my-search" />
ai-search/how-to/add-search-to-your-website.mdx line 50 PackageManagers for npx commands — Bare ```sh block contains only npx wrangler ai-search search ... Fix: Use <PackageManagers type="exec" pkg="wrangler" args="ai-search search my-search --query 'What is this site about?'" />
ai-search/how-to/connect-mcp-client.mdx line 45 enable/disable (for toggles) — Step uses 'then enable the MCP endpoint' for a dashboard toggle Fix: Change to 'then turn on the MCP endpoint'
Suggestions (4)
File Issue
ai-search/how-to/add-search-to-your-website.mdx line 79 Single-digit numerals in body text — Line uses 2 in body text (from step 2) Fix: Spell out the digit: from step two
ai-search/how-to/add-search-to-your-website.mdx line 141 Use refer to instead of see the [link] — Line says see the [React demo declarations] Fix: Change to refer to the [React demo declarations]
ai-search/how-to/add-search-to-your-website.mdx line 165 Single-digit numerals in body text — Line uses 5 in body text (as in step 5) Fix: Spell out the digit: as in step five
ai-search/how-to/connect-mcp-client.mdx line 47 Passive voice — Line uses passive voice: 'The MCP endpoint is served through your instance's public endpoint' Fix: Rewrite in active voice, e.g., 'Your instance's public endpoint serves the MCP endpoint'

Redirects

No missing redirect entries found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/ai-search/ @rita3ko, @irvinebroque, @aninibread, @G4brym, @mchenco, @cloudflare/product-owners

@ask-bonk ask-bonk Bot added the documentation Documentation edits label Jul 6, 2026

@ask-bonk ask-bonk Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No build-breaking issues found, but 2 items need attention.

MEDIUM

  • PR description is empty. Add a summary explaining the changes (converting concept pages to how-tos, adding the human-in-the-loop tutorial) and check the documentation checklist items.

LOW

  • src/content/docs/ai-search/how-to/nlweb.mdx:18: Uses contraction "you're" and the word "please", both prohibited by the style guide. I cannot suggest this inline because the line was not modified in this PR.

What this PR changes
Converts four ai-search/how-to pages from concept to how-to format with numbered steps, prerequisites, PackageManagers/WranglerConfig/TypeScriptExample components, and Next steps sections. Also adds a new tutorial page for building a human-in-the-loop knowledge base agent with Code Mode, and adjusts sidebar ordering to accommodate the new page.

@ask-bonk

ask-bonk Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Done.

Actions taken:

Findings:

  • MEDIUM: The PR description is completely empty (only the unchecked template remains). The author should add a summary of the changes and complete the documentation checklist.
  • LOW: src/content/docs/ai-search/how-to/nlweb.mdx:18 violates the style guide twice — it uses the contraction "you're" and the word "please". Neither line was modified in this diff, so I couldn't attach an inline suggestion.

What the PR changes:
Converts four ai-search/how-to pages from concept to how-to format, adding numbered steps, prerequisites, PackageManagers/WranglerConfig/TypeScriptExample usage, and Next steps sections. It also introduces a new tutorial page (human-in-the-loop-knowledge-base.mdx) for building an approval-gated knowledge base agent with Code Mode, and adjusts sidebar ordering across the section.

github run

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Preview URL: https://06d2bb3f.preview.developers.cloudflare.com
Preview Branch URL: https://anni-ai-search-how-tos.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/ai-search/how-to/human-in-the-loop-knowledge-base/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/human-in-the-loop-knowledge-base/
https://developers.cloudflare.com/ai-search/how-to/fetch-and-index-web-pages/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/fetch-and-index-web-pages/
https://developers.cloudflare.com/ai-search/how-to/add-search-to-your-website/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/add-search-to-your-website/
https://developers.cloudflare.com/ai-search/how-to/per-tenant-search/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/per-tenant-search/
https://developers.cloudflare.com/ai-search/how-to/bring-your-own-generation-model/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/bring-your-own-generation-model/
https://developers.cloudflare.com/ai-search/how-to/connect-mcp-client/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/connect-mcp-client/
https://developers.cloudflare.com/ai-search/how-to/simple-search-engine/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/simple-search-engine/
https://developers.cloudflare.com/ai-search/how-to/nlweb/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/how-to/nlweb/
https://developers.cloudflare.com/ai-search/configuration/retrieval/embed-search-snippets/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/configuration/retrieval/embed-search-snippets/
https://developers.cloudflare.com/ai-search/configuration/indexing/syncing/ https://anni-ai-search-how-tos.preview.developers.cloudflare.com/ai-search/configuration/indexing/syncing/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants