Skip to content

[AI Search] Add interactive indexing and querying diagrams#31884

Open
aninibread wants to merge 8 commits into
productionfrom
anni/ais-diagram
Open

[AI Search] Add interactive indexing and querying diagrams#31884
aninibread wants to merge 8 commits into
productionfrom
anni/ais-diagram

Conversation

@aninibread

@aninibread aninibread commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Screenshots (optional)

image image image

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 4, 2026

Copy link
Copy Markdown
Contributor

Review

⚠️ 1 warning, 💡 5 suggestions found in commit ed6429e.

Code Review

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

Suggestions (2)
File Issue
src/components/AiSearchOverviewDiagram.astro line 1 New web component not in component-named directory — The component defines the custom element <cfdocs-ai-search-overview-diagram> but is placed directly at src/components/AiSearchOverviewDiagram.astro. Existing cfdocs-\* web components live in subdirectories like src/components/sheet/ and src/components/explain-code-sheet/. Fix: Move the component into src/components/ai-search-overview-diagram/ (e.g., src/components/ai-search-overview-diagram/AiSearchOverviewDiagram.astro) to match the repository convention for new web components.
src/components/AiSearchQueryingDiagram.astro line 643 Misleading CSS comment — The comment claims the a.asqd-cap rule styles "the query input, the endpoint outputs", but the query input (.asqd-start) is still a <div> and is not matched by a.asqd-cap. Fix: Update the comment to describe only the endpoint output caps, or wrap the start cap in an <a> if it is intended to be clickable.

Conventions

Checks PR title, description, and redirect checklist.

Warnings (1)
File Issue
PR Description explains the work — The description's Summary section contains only the template placeholder with no human-written explanation, and the rest of the body is only screenshots and an unchecked checklist. Fix: Add a brief human-written summary that explains what the PR does, e.g., "Adds interactive Mermaid/architecture diagrams to the AI Search docs showing indexing and querying flows."

Style Guide Review

Suggestions (3)
File Issue
ai-search/configuration/ai-gateway.mdx line 13 Use refer to [link] instead of see [link] — Line adds To choose or change which gateway your instance uses, see [Models](/ai-search/configuration/models/). Fix: Replace see [Models] with refer to [Models].
ai-search/configuration/ai-gateway.mdx line 27 Use refer to [link] instead of see [link] — Line adds For details, see [Models](/ai-search/configuration/models/). Fix: Replace see [Models] with refer to [Models].
ai-search/configuration/ai-gateway.mdx line 19 Bullet lists should have at least three items — Patch adds a two-item bulleted list under ## Observe your model calls (Analytics and Logs). Fix: Consider rewriting the two items as prose instead of a bullet list.

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 4, 2026

Copy link
Copy Markdown
Contributor

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

Pattern Owners
*.astro @cloudflare/content-engineering, @kodster28
*.ts @cloudflare/content-engineering, @kodster28
/src/content/docs/ai-search/ @rita3ko, @irvinebroque, @aninibread, @G4brym, @mchenco, @cloudflare/product-owners

@ask-bonk ask-bonk Bot added documentation Documentation edits docs engine Requires a change to the docs engine labels Jul 4, 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.

Build passes (pnpm run check, lint, format:core:check). Code is well-structured.

Issues needing action:

  • PR titleAnni/ais diagram is vague and doesn't follow commit conventions. Suggest: [AI Search] Add interactive indexing and querying diagrams.
  • PR description — Body is empty (template placeholders only). A brief summary and filled checklist help reviewers.

Minor cleanup (non-blocking):

  • AiSearchQueryingDiagram.astro skips step numbers 2 and 3. Consider renumbering sequentially to avoid confusion for future maintainers.

Posted 1 inline suggestion.

Comment thread src/components/AiSearchIndexingDiagram.astro
@aninibread aninibread changed the title Anni/ais diagram [AI Search] Add interactive indexing and querying diagrams Jul 4, 2026
@ask-bonk

ask-bonk Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Done.

Summary of this PR review for #31884:

What changed 4 files: 2 new interactive Astro diagram components (AiSearchIndexingDiagram, AiSearchQueryingDiagram), re-exported from src/components/index.ts, and embedded in the how-ai-search-works.mdx concept page.
Labels applied documentation, docs engine
Build status ✅ Passes (pnpm run check, lint, format:core:check)

Issues flagged:

  1. PR title (Anni/ais diagram) — does not follow commit conventions. Suggested: [AI Search] Add interactive indexing and querying diagrams.
  2. PR description — completely empty; only template placeholders remain.
  3. Minor cleanupAiSearchQueryingDiagram.astro skips step numbers 2 and 3 in its animation sequence.
  4. Inline suggestion — removed an unused data-keyword DOM attribute from AiSearchIndexingDiagram.astro (the prop is consumed server-side by Astro, so the attribute is dead code in the custom element).

github run

@irvinebroque irvinebroque removed their assignment Jul 5, 2026
aninibread and others added 2 commits July 5, 2026 20:03
Add AiSearchNamespacesDiagram illustrating instance-per-tenant
multitenancy: several tenant requests reach one Worker, which uses its
namespace binding to route each to its own isolated AI Search instance.
Move the "Why use namespaces" section up under the page overview.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs engine Requires a change to the docs engine documentation Documentation edits product:ai-search size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants