Skip to content
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

[BRAPI]Markdown endpoint docs #21017

Open
wants to merge 1 commit into
base: production
Choose a base branch
from
Open

Conversation

daisyfaithauma
Copy link
Contributor

Summary

  • Markdown docs

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.

@daisyfaithauma daisyfaithauma requested review from mchenco, celso, danielgek and a team as code owners March 21, 2025 12:19
Copy link
Contributor

hyperlint-ai bot commented Mar 21, 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 documentation to include a new Markdown extraction endpoint and modified the sidebar order for the API reference.

  • Added documentation for the new /markdown endpoint that converts webpage content to Markdown format.
  • Updated the sidebar order for the API reference section.

Modified Files

  • src/content/docs/browser-rendering/rest-api/api-reference.mdx

Added Files

  • src/content/docs/browser-rendering/rest-api/markdown-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.

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.

@daisyfaithauma daisyfaithauma changed the title Markdown endpoint docs [BRAPI]Markdown endpoint docs Mar 21, 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.

5 participants