Skip to content

Conversation

@kathayl
Copy link
Contributor

@kathayl kathayl commented Jun 23, 2025

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • 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.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Jun 23, 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

Updated the documentation for the /pdf endpoint to provide clearer instructions and additional use cases for generating PDFs.

  • Expanded the description of the /pdf endpoint to include generating PDFs from custom HTML.
  • Added a section on common use cases for the PDF generation feature.
  • Included a new example for converting a URL to PDF and clarified the usage of the html option.

Modified Files

  • src/content/docs/browser-rendering/rest-api/pdf-endpoint.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
/src/content/docs/browser-rendering/ @mchenco, @cloudflare/pcx-technical-writing, @celso, @danielgek, @kathayl, @ToriLindsay

@github-actions
Copy link
Contributor

github-actions bot commented Jun 23, 2025

@kathayl
Copy link
Contributor Author

kathayl commented Jun 23, 2025

Trying to make our docs more clear because it seems users don't actually go to the api docs to find all the extra customization they can do (https://developers.cloudflare.com/api/resources/browser_rendering/subresources/pdf/)
--> Ended up just bringing up the part about going to API docs to the top of "advanced usage". Also cleaned up a bit what we had already:

  1. Endpoint - added section with endpoint clearly shown. Separate from just being within the examples
  2. Required fields - added section with what must be included. Wondering whether this is a good place to point them to api docs that will have all the info on customizations they can do
  3. Common use cases - added section to just give people ideas of what they can do
  4. moved the existing HTML to PDF section to Basic usage and added nesting to the examples

--output "invoice.pdf"
```

## Advanced usage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Advanced usage

@kathayl kathayl enabled auto-merge (squash) June 25, 2025 16:55
@kathayl kathayl merged commit e3ff90f into production Jun 25, 2025
11 checks passed
@kathayl kathayl deleted the kathayl-patch-8 branch June 25, 2025 16:57
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants