Skip to content

[BRAPI]added details to titles for better descriptions #22044

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 3 commits into from
Apr 29, 2025

Conversation

daisyfaithauma
Copy link
Contributor

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.

Copy link
Contributor

hyperlint-ai bot commented Apr 28, 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

Enhanced titles across multiple documentation pages to include specific endpoint references for clarity.

  • Updated titles to include endpoint references for better context
  • Modified titles in several how-to documentation files
  • Improved overall documentation clarity and usability

Modified Files

  • src/content/docs/browser-rendering/rest-api/content-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/json-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/links-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/markdown-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/pdf-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/scrape-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx
  • src/content/docs/browser-rendering/rest-api/snapshot.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.

@daisyfaithauma daisyfaithauma changed the title added details to titles for better descriptions [BRAPI]added details to titles for better descriptions Apr 28, 2025
Copy link
Contributor

github-actions bot commented Apr 28, 2025

Preview URL: https://6dd25316.preview.developers.cloudflare.com
Preview Branch URL: https://endpoint-links.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/browser-rendering/rest-api/content-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/content-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/json-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/json-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/links-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/links-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/markdown-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/markdown-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/pdf-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/pdf-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/scrape-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/scrape-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/screenshot-endpoint/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/screenshot-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/snapshot/ https://endpoint-links.preview.developers.cloudflare.com/browser-rendering/rest-api/snapshot/

@daisyfaithauma daisyfaithauma marked this pull request as ready for review April 29, 2025 00:38
@kathayl kathayl enabled auto-merge (squash) April 29, 2025 16:45
@kathayl kathayl merged commit 27f2436 into production Apr 29, 2025
13 checks passed
@kathayl kathayl deleted the endpoint-links branch April 29, 2025 16:56
GregBrimble pushed a commit that referenced this pull request May 1, 2025
* added details to titles for better descriptions

* better option

* Update scrape-endpoint.mdx
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