Skip to content

Reduce superfluous <Tabs> usage inside images transform docs #21593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 1, 2025

Conversation

dochne
Copy link
Contributor

@dochne dochne commented Apr 10, 2025

Summary

The value of providing examples to our users on the URL transforms page through the use of tabs is about giving examples about how they can use specific flags.

We're currently going overkill with it's usage to the point that it's distracting from trying to read the documentation. This PR pairs it down a little so we only give one example per flag.

Screenshots (optional)

Before:

image

After

image

Documentation checklist

Copy link
Contributor

hyperlint-ai bot commented Apr 10, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Reduced excessive use of tabs in the images transform documentation to enhance readability and focus on key examples.

  • Streamlined examples for URL transforms by limiting to one per flag
  • Removed redundant tab sections for various image fit options
  • Consolidated gravity parameter examples to improve clarity
  • Updated metadata options to eliminate unnecessary tab usage

Modified Files

  • src/content/partials/images/background.mdx
  • src/content/partials/images/fit.mdx
  • src/content/partials/images/gravity.mdx
  • src/content/partials/images/metadata.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link
Contributor

github-actions bot commented Apr 10, 2025

@dcpena dcpena merged commit 1f2c64e into production May 1, 2025
12 checks passed
@dcpena dcpena deleted the doug/images-improvements branch May 1, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants