search

fluxninja / aperture

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

Update SDK READMEs for v1 announcement #3175

Closed hdkshingala closed 7 months ago

hdkshingala commented 7 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago

Walkthrough

The updates across various SDK README.md files reflect a unified shift in focus from merely presenting SDKs for different programming languages to highlighting the launch of a version 1 managed rate limiting service. This service is now the centerpiece, with the documentation emphasizing support, feedback channels, and a rebranding of the SDK titles to reflect their core functionality of rate limiting in respective programming languages.

Changes

Files Change Summary
.../aperture-csharp/README.md Launch of v1 managed rate limiting service, new links for engagement, title change to "Rate Limiting for C# Applications."
.../aperture-go/README.md Introduction of launch announcement, support links, focus shift to "Rate Limiting for Golang Applications."
.../aperture-java/README.md Launch of v1 managed rate limiting service announced, title updated to "Rate Limiting for Java Applications."
.../aperture-js/README.md Highlights the launch of the managed rate limiting service, moves focus to service promotion.
.../aperture-py/README.md Announces v1 of the managed rate limiting service, title change to "Rate Limiting for Python Applications."

🐇✨
In the world of code, where limits must be set,
A service emerges, in its prime and yet,
With links and titles, anew and refined,
We hop to the future, with rate limits defined.
🌟🐾

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 .` - `Generate unit-tests for this file.` - 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 tests 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 generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 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` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.