Ksohi/new snippets and docs rework

[karansohi]

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

Summary by CodeRabbit

• Documentation

  • Reorganized the sidebar positioning for improved navigation:
  • "API Quota Management" moved to position 4.
  • "Managing OpenAI API Rate Limits" moved to position 6.
  • "Per-user Concurrency Limiting" moved to position 2.
  • Updated guides with new file paths and image references for "Concurrency Quota Management."

• Refactor

  • Enhanced SDK examples with asynchronous behavior for better control flow:
  • Added await keyword for flow.end() calls in basic usage and concurrency limit examples.
  • Introduced a new asynchronous function UIConcurrencyTokens for managing concurrency tokens in UI components.

[coderabbitai[bot]]

Walkthrough

The recent updates involve reordering sidebar elements in the documentation and enhancing asynchronous behavior in the JavaScript SDK examples. Sidebar positions for guides on API and concurrency quota management, as well as rate limits, have been shifted. Additionally, the JavaScript SDK usage examples now correctly implement await for asynchronous calls, ensuring proper flow control.

Changes

File Path	Change Summary
docs/.../api-quota-management.md	Sidebar position changed from 2 to 4
docs/.../concurrency-quota-management.md	File paths and image references updated
docs/.../openai.md	Sidebar position changed from 4 to 6
docs/.../per-user-concurrency-limiting.md	Sidebar position changed from 1 to 2
sdks/aperture-js/example/... (multiple files)	Added await to flow.end() calls; new UIConcurrencyTokens function

Poem

🐇✨
In the docs, a shuffle, a slide,
Sidebar dances, numbers aside.
Code awaits patiently in line,
A rabbit's touch, async in time. 🌟🕒

---

Tips

### Chat with CodeRabbit Bot (`@coderabbitai`) - You can directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging `@coderabbitai` in a comment. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - You can tag `@coderabbitai` in a PR comment and ask questions about the PR and the codebase. 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.` - `@coderabbitai read the files in the src/scheduler package and generate 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. ### 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.