Skip to content

Add autorag recipes page #21709

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

Conversation

G4brym
Copy link
Contributor

@G4brym G4brym commented Apr 15, 2025

Summary

Adds autorag recipes page

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 15, 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

Added a new autorag recipes page to provide practical examples for common use cases and updated existing documentation for clarity.

  • Introduced a new recipes page for AutoRAG with practical examples.
  • Updated indexing documentation to include a link to size limits.
  • Provided code examples for using AutoRAG with custom models and simple search engines.

Modified Files

  • src/content/docs/autorag/configuration/indexing.mdx

Added Files

  • src/content/docs/autorag/usage/recipes.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.

@G4brym G4brym force-pushed the gmassadas/add-autorag.recipes branch from eb487f7 to 42a47b3 Compare April 15, 2025 14:35
Copy link
Contributor

@aninibread aninibread left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved! inline comments optional but would be nice to have

@aninibread aninibread merged commit 7366e17 into cloudflare:production Apr 16, 2025
7 checks passed
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* Add autorag recipes page

* Update src/content/docs/autorag/usage/recipes.mdx

Co-authored-by: Anni Wang <[email protected]>

* Update src/content/docs/autorag/usage/recipes.mdx

Co-authored-by: Anni Wang <[email protected]>

* Add inline comments

---------

Co-authored-by: Anni Wang <[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.

6 participants