Skip to content

Commit

Permalink
Add Caching to introduction and readme (#3031)
Browse files Browse the repository at this point in the history
- Fix rate limiting guide with correct example

### Description of change

##### Checklist

- [ ] Tested in playground or other setup
- [ ] Screenshot (Grafana) from playground added to PR for 15+ minute
run
- [x] Documentation is changed or added
- [ ] Tests and/or benchmarks are included
- [ ] Breaking changes


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Updated the README to include information on new caching features for
performance improvement and cost reduction.
- Revised the developer guide on per-user rate limiting to reflect code
examples in TypeScript instead of Python.
- Added a section in the introduction about the benefits of caching
within the application.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
karansohi authored Dec 6, 2023
1 parent 6de3000 commit 3acb6b6
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ cloud application:
Aperture aligns resource distribution with business value and urgency of
requests. Workload prioritization applies to API Quota Management and Adaptive
Queuing use cases.
- 💾 [**Caching**]: Boost application performance and reduce costs by caching
costly operations, preventing duplicate requests to pay-per-use services, and
easing the load on constrained services.

## 🏗️ Architecture

Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/per-user-rate-limiting.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The first step to use Aperture SDK is to import and set up Aperture Client:
<TabItem value="Typescript">
```

<CodeSnippet lang="py" snippetName="clientConstructor" />
<CodeSnippet lang="ts" snippetName="clientConstructor" />

```mdx-code-block
</TabItem>
Expand Down
3 changes: 3 additions & 0 deletions docs/content/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ To sign-up to Aperture Cloud, [click here][sign-up].
Aperture aligns resource distribution with business value and urgency of
requests. Workload prioritization applies to API Quota Management and Adaptive
Queuing use cases.
- 💾 [**Caching**]: Boost application performance and reduce costs by caching
costly operations, preventing duplicate requests to pay-per-use services, and
easing the load on constrained services.

## ✨ Get started {#get-started}

Expand Down

0 comments on commit 3acb6b6

Please sign in to comment.