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

Cache Concept Doc #3052

Closed hasit closed 9 months ago

hasit commented 9 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 9 months ago

Walkthrough

The documentation has been updated to improve navigation and enhance understanding of Aperture's caching mechanisms. A sidebar position has been adjusted, a new guide on caching has been added, and existing caching instructions have been clarified to better guide users through the process of utilizing Aperture's Cache via SDKs and ensuring proper telemetry data submission.

Changes

File Path Change Summary
.../concepts/advanced/advanced.md Updated sidebar_position from 7 to 8.
.../content/concepts/cache.md Added new file detailing Aperture's Cache usage. Clarified caching process, ttl settings, and telemetry data submission.

🐇✨ To the docs, a change we bring,
A cache guide and a sidebar fling.
With each careful tweak and tune,
We hop towards clarity, under the moon. 🌙


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - You can reply to a review comment made by CodeRabbit. - You can tag CodeRabbit on specific lines of code or files in the PR by tagging `@coderabbitai` in a comment. - You can tag `@coderabbitai` in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions. ### 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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`