Skip to content

[Analytics] Fix broken GraphiQL images, add image style rule - #33004

Merged
mvvmm merged 1 commit into
productionfrom
fix-graphql-reference-image-links
Aug 25, 2026
Merged

[Analytics] Fix broken GraphiQL images, add image style rule#33004
mvvmm merged 1 commit into
productionfrom
fix-graphql-reference-image-links

Conversation

@mvvmm

@mvvmm mvvmm commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fixes all broken images on two GraphiQL getting-started pages:

  • analytics/graphql-api/getting-started/compose-graphql-query/
  • analytics/graphql-api/getting-started/explore-graphql-schema/

Both pages used reference-style image links (![alt][n] + [n]: ~/assets/images/...). Astro's asset pipeline only resolves the ~/assets/images/ alias for inline image syntax, so these rendered as broken page-relative URLs. Converted all 22 images to inline syntax.

Also added a style-guide rule to prevent regression:

  • Flue style-guide-review skill (reference/conditional/images.md) — warns on reference-style image links, with eval cases and a fixture
  • Top-level skill (/agents/references/style-guide.md) — bans reference-style image links in the Screenshots and images section

@github-actions github-actions Bot added product:analytics Related to Analytics product size/m labels Aug 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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

Pattern Owners
* @cloudflare/product-owners
*.ts @cloudflare/content-engineering, @kodster28
/src/content/docs/analytics/ @soheiokamoto, @angelampcosta, @rianvdm, @cloudflare/product-owners

@cloudflare-workers-and-pages

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://fix-graphql-reference-image-links.previews.developers.cloudflare.com, https://fix-graphql-reference-image-links-cloudflare-docs.cloudflare-docs.workers.dev (commit 420bbab)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://8d59926e.previews.developers.cloudflare.com, https://8d59926e-cloudflare-docs.cloudflare-docs.workers.dev 420bbab 2026-08-25T14:03:42.575Z Visit the dashboard ↗

@mvvmm
mvvmm marked this pull request as ready for review August 25, 2026 14:32
@mvvmm
mvvmm requested review from a team, kodster28, rianvdm and soheiokamoto as code owners August 25, 2026 14:32
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Review

💡 1 suggestion found in commit 420bbab.

👉 Fix in your agent 👈
Fix the following review findings in PR #33004 (https://github.com/cloudflare/cloudflare-docs/pull/33004).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.

The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.

---

## Code Review

### Suggestions (1)

#### CR-246acb43c1d8 · Duplicate image reference for distinct steps
- **File:** `src/content/docs/analytics/graphql-api/getting-started/compose-graphql-query.mdx` line 59
- **Issue:** `graphiql-set-up-base-query.png` is reused at line 59 (hovering over a field to display its description) and again at line 89 (hovering over a dataset to display available fields). The two alt texts describe different UI interactions, so the same screenshot is likely incorrect for at least one of them.
- **Fix:** Verify the intended screenshot for each described interaction and use a distinct filename for one of the two references if the interactions are different.

Code Review

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

Suggestions (1)
File Issue
analytics/graphql-api/getting-started/compose-graphql-query.mdx line 59 Duplicate image reference for distinct stepsgraphiql-set-up-base-query.png is reused at line 59 (hovering over a field to display its description) and again at line 89 (hovering over a dataset to display available fields). The two alt texts describe different UI interactions, so the same screenshot is likely incorrect for at least one of them. Fix: Verify the intended screenshot for each described interaction and use a distinct filename for one of the two references if the interactions are different.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues 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.
/rebase Rebases the PR branch against production. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

@mvvmm
mvvmm merged commit 33e789a into production Aug 25, 2026
24 checks passed
@mvvmm
mvvmm deleted the fix-graphql-reference-image-links branch August 25, 2026 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:analytics Related to Analytics product size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants