docs(cache): fix withEncryption import in overview.mdx example

[CanRau]

🤓

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and structure of the @unkey/cache library documentation.
  • Introduced new sections on "Namespaces," "Tiered Cache," and "Stale-While-Revalidate" with detailed explanations and code examples.
  • Improved presentation of code snippets for various usage scenarios.
  • Expanded sections on "Stores" and "Middlewares" with specific implementations and examples.
  • Added context for serverless functions and introduced encryption middleware for securing cache values.

[changeset-bot]

⚠️ No Changeset found

Latest commit: d825208

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 16, 2024 1:46am

[vercel]

@CanRau is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request focuses on updating the documentation for the @unkey/cache library in the apps/docs/libraries/ts/cache/overview.mdx file. The update provides a more comprehensive and structured explanation of the library's features, including detailed sections on Namespaces, Tiered Cache, Stale-While-Revalidate, Stores, and Middlewares. The documentation now includes clearer code examples and explanations for different usage scenarios, such as serverless functions, various storage options, and encryption middleware.

Changes

File	Change Summary
apps/docs/libraries/ts/cache/overview.mdx	- Added detailed sections on library features - Expanded explanations for Namespaces, Tiered Cache, and Stale-While-Revalidate - Improved documentation on Stores and Middlewares - Added code examples for different usage scenarios - Enhanced context for serverless functions

Possibly related PRs

• docs: update overview.mdx #2384: Updates documentation for @unkey/cache library, covering MemoryStore, CloudflareStore, and Upstash Redis
• chore: add override routes in unkey ratelimit sdk docs #2741: Enhances documentation for Unkey ratelimit SDK with information about override routes

Suggested labels

🕹️ oss.gg, :joystick: 50 points

Suggested reviewers

• mcstepp
• MichaelUnkey
• chronark
• perkinsjr

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74f8359 and d825208.

📒 Files selected for processing (1)

• apps/docs/libraries/ts/cache/overview.mdx (1 hunks)

🔇 Additional comments (1)

apps/docs/libraries/ts/cache/overview.mdx (1)

882-882: LGTM! Import statement is now correctly using the middleware path.

The import statement for withEncryption from @unkey/cache/middleware aligns with the package's structure and follows the same pattern as other middleware imports in the documentation.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏