Skip to content

Conversation

@dochne
Copy link
Contributor

@dochne dochne commented May 13, 2025

Summary

Codeblocks in the codebase work like this:

console.log("my code here");

In certain circumstances, prettier tries to push this into one line:
js console.log("my code here");

This isn't supported and leads to incorrect looking output:
image

This PR fixes a couple of files that were inadvertently broken and adds them to the .prettierignore list so that it doesn't automatically break again.

Documentation checklist

@hyperlint-ai-deprecated
Copy link
Contributor

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

Fixed issues with codeblocks in Images documentation to prevent formatting errors caused by Prettier.

  • Corrected codeblock formatting in multiple documentation files
  • Added affected files to .prettierignore to prevent future formatting issues
  • Ensured adherence to the documentation style guide

Modified Files

  • src/content/partials/images/metadata.mdx
  • src/content/partials/images/onerror.mdx
  • src/content/partials/images/slow-connection-quality.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.

@github-actions
Copy link
Contributor

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

Pattern Owners
* @cloudflare/pcx-technical-writing

@dochne dochne force-pushed the doug/fix-bad-codeblocks branch from b0391be to 9b4ae6c Compare May 13, 2025 19:45
@dcpena dcpena enabled auto-merge (squash) May 13, 2025 19:48
@github-actions
Copy link
Contributor

@dcpena dcpena merged commit caca61d into production May 13, 2025
12 checks passed
@dcpena dcpena deleted the doug/fix-bad-codeblocks branch May 13, 2025 19: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