[Analytics] Fix broken GraphiQL images, add image style rule - #33004
Merged
Conversation
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
🚀 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 deploymentPreview Deployments by commit
|
Contributor
mvvmm
marked this pull request as ready for review
August 25, 2026 14:32
mvvmm
requested review from
a team,
kodster28,
rianvdm and
soheiokamoto
as code owners
August 25, 2026 14:32
Contributor
Review💡 1 suggestion found in commit 👉 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 ReviewThis code review is in beta and may not always be helpful — use your judgment. Suggestions (1)
ConventionsNo convention issues found. Style Guide ReviewNo style-guide issues found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
kodster28
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
reference/conditional/images.md) — warns on reference-style image links, with eval cases and a fixture/agents/references/style-guide.md) — bans reference-style image links in the Screenshots and images section