Skip to content

Improve API and documentation clarity #22184

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

Closed

Conversation

hyperlint-ai[bot]
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot commented May 2, 2025

This pull request updates various documentation files to comply with the style guide, addressing issues such as unclear antecedents, non-standard quotes, end-of-line whitespace, contractions, and the use of Latin terms. The changes enhance clarity and consistency across the documentation.

  • Updated sentences for clarity and compliance with the style guide in make-api-calls.mdx and changelog.mdx.
  • Replaced non-standard quotes with standard quotes in multiple files including cloudflare-ray-id.mdx and cloudflare-cookies.mdx.
  • Removed end-of-line whitespace in cloudflare-ray-id.mdx and cybersafe.mdx.
  • Changed contractions to full forms in delivering-videos-with-cloudflare.mdx and provide-specific-urls.mdx.
  • Replaced 'e.g.' with 'for example' in delivering-videos-with-cloudflare.mdx.
  • Ensured consistent use of possessive forms in changelog.mdx and cloudflare-cookies.mdx.
  • Updated various files to enhance overall readability and adherence to the style guide.

Copy link
Contributor

github-actions bot commented May 2, 2025

Preview URL: https://92cbcb8e.preview.developers.cloudflare.com
Preview Branch URL: https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/fundamentals/reference/policies-compliances/delivering-videos-with-cloudflare/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/policies-compliances/delivering-videos-with-cloudflare/
https://developers.cloudflare.com/fundamentals/changelog/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/changelog/
https://developers.cloudflare.com/fundamentals/reference/policies-compliances/cloudflare-cookies/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/policies-compliances/cloudflare-cookies/
https://developers.cloudflare.com/fundamentals/reference/report-abuse/provide-specific-urls/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/report-abuse/provide-specific-urls/
https://developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-solve-issues/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/security/cloudflare-challenges/challenge-solve-issues/
https://developers.cloudflare.com/fundamentals/api/how-to/make-api-calls/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/api/how-to/make-api-calls/
https://developers.cloudflare.com/fundamentals/reference/cloudflare-ray-id/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/cloudflare-ray-id/
https://developers.cloudflare.com/fundamentals/reference/policies-compliances/content-security-policies/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/policies-compliances/content-security-policies/
https://developers.cloudflare.com/fundamentals/reference/policies-compliances/cybersafe/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/policies-compliances/cybersafe/
https://developers.cloudflare.com/fundamentals/reference/scans-penetration/ https://hyperlint-automation-repository-scan-8100291.preview.developers.cloudflare.com/fundamentals/reference/scans-penetration/

@kodster28 kodster28 closed this May 5, 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.

2 participants