fluxninja / aperture

Rate limiting, caching, and request prioritization for modern workloads
https://docs.fluxninja.com
Apache License 2.0
622 stars 24 forks source link

Add Caching Guide[WIP] #3042

Closed karansohi closed 9 months ago

karansohi commented 9 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 9 months ago

[!IMPORTANT]

Auto Review Skipped

Ignore keyword(s) in the title.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The documentation and example code for an SDK named Aperture have been updated. The sidebar position for the API Quota Management guide has been moved up for better visibility. A new guide on caching with detailed instructions and code snippets has been added, emphasizing its importance for application performance. Additionally, an example TypeScript file for the Aperture JS SDK has been introduced, showcasing how to initialize the client and monitor caching.

Changes

File Path Change Summary
.../api-quota-management.md Changed sidebar_position from 3 to 2.
.../guides/caching.md Added new guide on caching with instructions and code examples.
.../aperture-js/example/caching_example.ts Added new example module for caching with ApertureClient.

🐇✨ In the docs, a change does creep,
A guide on caching, not a peep.
Sidebar shifts, a nudge, a leap,
CodeRabbit's work, the detail's deep. 🌟📚


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json`