Skip to content

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

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

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

Conversation

@aninibread

@aninibread aninibread commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Screenshots (optional)

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

⚠️ 2 warnings, 💡 1 suggestion found in commit 55aa219.

Code Review

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

Suggestions (1)
File Issue
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 (2)
File Issue
PR Product or area identified — The title "Anni/ais diagram" does not name a recognizable product, feature, or docs content area. Fix: Rewrite the title to identify the affected docs area, e.g. prefix with a product tag like [AI Gateway] or a type prefix like docs:.
PR Description explains the work — The description contains only the empty PR template; the Summary section and checklist items are unfilled. Fix: Fill in the Summary section with a brief, human-written explanation of what the diagram adds or changes.

Style Guide Review

No style-guide issues found.

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.

<cfdocs-ai-search-indexing-diagram
data-autoplay={String(autoPlay)}
data-loop={String(loop)}
data-keyword={String(keyword)}

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.

Remove unused attribute:

Suggested change
data-keyword={String(keyword)}
data-loop={String(loop)}

@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

@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

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.

6 participants