fluxninja / aperture

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

Update SDK Docs #3056

Closed karansohi closed 11 months ago

karansohi commented 11 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 11 months ago

Walkthrough

The documentation and examples across various SDKs have been updated to reflect a shift in terminology from "manually setting" to "defining" feature control points. The sidebar positions for SDK content have been reorganized to improve navigation flow. Installation instructions have been added or clarified, and code snippets have been expanded to include additional labels and explanations. Examples across multiple languages now uniformly include more detailed label dictionaries, indicating a move towards more granular control of features.

Changes

File Path Change Summary
docs/content/sdk/*/manual.md Title changed to "Define Control Points." Installation instructions and code snippet explanations added.
docs/content/sdk/*/go.md,
docs/content/sdk/*/java.md,
docs/content/sdk/*/python/manual.md
Sidebar positions updated for .NET, Go, Java, and Python sections.
sdks/aperture-csharp/Examples/Program.cs Updated labels dictionary logic to include additional key-value pairs.
sdks/aperture-go/examples/manual_flow/main.go,
sdks/aperture-java/examples/standalone-example/src/main/java/com/fluxninja/example/App.java,
sdks/aperture-js/example/quota_scheduler_example.ts,
sdks/aperture-js/example/ui_snippets.ts,
sdks/aperture-py/example/manual_flow.py
Added new key-value pairs to labels in Go, Java, and Python examples. Removed QSUI comments and updated UI function names and logic in JavaScript examples.

🐇✨ Changes abound in docs and code,
A rabbit hopped through, leaving knowledge bestowed.
With labels defined, and sidebars aligned,
The burrow's tech stack is now refined. 🚀📚


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`