Skip to content

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 a team, celso, danielgek and mchenco as code owners March 21, 2025 12:19
@hyperlint-ai
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.

@daisyfaithauma daisyfaithauma changed the title Markdown endpoint docs [BRAPI]Markdown endpoint docs Mar 21, 2025
@daisyfaithauma daisyfaithauma requested a review from kathayl as a code owner April 4, 2025 10:54
@daisyfaithauma daisyfaithauma merged commit 8b89f1e into production Apr 4, 2025
11 checks passed
@daisyfaithauma daisyfaithauma deleted the markdown-endpoint branch April 4, 2025 13:14
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* Markdown endpoint docs

* New header

* Update src/content/docs/browser-rendering/rest-api/markdown-endpoint.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/browser-rendering/rest-api/markdown-endpoint.mdx

Co-authored-by: Jun Lee <[email protected]>

---------

Co-authored-by: Jun Lee <[email protected]>
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.

7 participants