[AIG]new docs for Websockets

[daisyfaithauma]

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]

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

Introduced comprehensive documentation for the WebSockets API, detailing both non-realtime and realtime functionalities.

• Added a new page for the WebSockets API overview, including key differences between non-realtime and realtime APIs.
• Created detailed documentation for the Non-realtime WebSockets API with setup instructions and examples.
• Developed documentation for the Realtime WebSockets API, including supported providers and authentication methods.

Added Files

• src/content/docs/ai-gateway/configuration/Websockets API/index.mdx
• src/content/docs/ai-gateway/configuration/Websockets API/non-realtime-api.mdx
• src/content/docs/ai-gateway/configuration/Websockets API/realtime-api.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.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

[kodster28]

Maybe wrap this instead in the output block?

https://developers.cloudflare.com/style-guide/components/code/#output

[kodster28]

Let's chat. If possible, we should structure this to be a Render with a param input.

Will save you a lot of potential maintenance

[kodster28]

I think your folder casing is off here.

websockets-api

We avoid spaces + capitalization in filenames

[kodster28]

Think the capitalization is still getting you, btw.

Websockets-api

[kodster28]

Closing b/c I messed this up 😢

[github-actions]

CI run failed: build logs