docs: update overview.mdx #2384
Conversation
avaliable -> available
eltociear
requested review from
perkinsjr,
chronark,
mcstepp and
MichaelUnkey
as code owners
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe changes in this pull request enhance the documentation for the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@eltociear is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for following the naming conventions for pull request titles! 🙏 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
apps/docs/libraries/ts/cache/overview.mdx (2)
Line range hint
48-228: Typo in Features list, otherwise LGTM.The Features and Quickstart sections provide clear and valuable information for users. The installation instructions and code examples effectively demonstrate basic usage.
However, there's a small typo in the Features list:
- It's used in production by Unkey any others. + It's used in production by Unkey and others.
Line range hint
653-1000: Minor formatting suggestions, overall LGTM.The Primitives section provides comprehensive information about different store types and middlewares. The explanations and code examples are clear and informative.
Consider improving the indentation of some code blocks for better readability. For example:
- const cloudflare = new CloudflareStore({ - cloudflareApiKey: "<CLOUDFLARE_API_KEY>", - zoneId: "<CLOUDFLARE_ZONE_ID>", - domain: "<YOUR_CACHE_DOMAIN>", - cacheBuster: "<CACHE_STORE_VERSION>", - }) + const cloudflare = new CloudflareStore({ + cloudflareApiKey: "<CLOUDFLARE_API_KEY>", + zoneId: "<CLOUDFLARE_ZONE_ID>", + domain: "<YOUR_CACHE_DOMAIN>", + cacheBuster: "<CACHE_STORE_VERSION>", + })Apply similar indentation improvements to other code blocks in this section for consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- apps/docs/libraries/ts/cache/overview.mdx (1 hunks)
🧰 Additional context used
🔇 Additional comments (4)
apps/docs/libraries/ts/cache/overview.mdx (4)
Line range hint
1-46: LGTM: Clear introduction and motivation.The introduction and motivation sections effectively explain the purpose of the library and the problems it aims to solve. The code example illustrates common caching issues well.
Line range hint
230-652: LGTM: Comprehensive explanation of key concepts.The Concepts section provides clear and detailed explanations of Namespaces, Tiered Cache, and Stale-While-Revalidate. The use of code examples and diagrams effectively enhances understanding of these key features.
Line range hint
1002-1004: LGTM: Clear contribution guidelines.The Contributing section provides concise and clear guidance for users who want to contribute new stores or middlewares to the library.
Line range hint
1-1004: Comprehensive and well-structured documentation, with minor suggestions for improvement.The documentation for the
@unkey/cachelibrary is thorough, covering all major aspects of the library's functionality. The explanations are clear, and the code examples effectively demonstrate usage.To further improve the documentation:
- Correct the typo in the Features list as mentioned earlier.
- Improve the indentation of code blocks in the Primitives section for better readability and consistency.
These minor improvements will enhance the already high-quality documentation.
|
Awarding eltociear: 50 points 🕹️ Well done! Check out your new contribution on oss.gg/eltociear |
avaliable -> available
avaliable -> available
* fix:breadcrum-cache-issue * chore:rename-revalidateMytag * refactor: move-revalidateTag * refactor: extract tags into reusable utility * feat: add template * Update 3_follow_the_unkey_x_account.md (#2323) * fix: capture uniqueness error and return it correctly (#2337) * docs: getVerifications instead of get (#2329) * Update 3_follow_the_unkey_x_account.md (#2324) Followed unkey on Twitter Co-authored-by: Andreas Thomas <dev@chronark.com> * fix: transaction ...: in use: for query (#2278) * fix: transaction ...: in use: for query - Fixes #2197 - The error is caused by the cache revalidation happening in the background, so we have a racecondition with the other queries we are running in the insertGenericAuditLogs function * docs: explain for future self * fix: another racecondition also bulk insert auditLogs and auditLogTargets * [autofix.ci] apply automated fixes --------- Co-authored-by: chronark <dev@chronark.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix: handle undefined ratelimits * Update 3_follow_the_unkey_x_account.md (#2338) * fix: handle case when blogs array is empty * [oss.gg] side quest : added another framework; hono on cloudflare workers. (#2345) * fix: weird spacing in changelog by removing the extra gap (#2340) * fix: weird spacing in changelog * feat: formatted * oss.gg: create a template for ratelimiting a oak server in deno with unkey (#2308) Co-authored-by: Andreas Thomas <dev@chronark.com> * follow unkey on X #2252 (#2315) Co-authored-by: Your Name <you@example.com> * Follow the Unkey X account: @unkeydev Complete! (#2332) * Update 3_follow_the_unkey_x_account.md * Update 3_follow_the_unkey_x_account.md --------- Co-authored-by: Andreas Thomas <dev@chronark.com> * fix(www): analytics bento code snippet is not readable (#2311) - add hover effect to analytics bento removing gradient background - make copy code button sticky to top-right corner - impl independent vertical scrolls for language switcher and code editor * Update 7_create_a_template.md * Update 7_create_a_template.md * chore(deps-dev): bump @content-collections/core from 0.6.2 to 0.7.2 (#2255) Bumps @content-collections/core from 0.6.2 to 0.7.2. --- updated-dependencies: - dependency-name: "@content-collections/core" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: order audit logs by time, show latest on top (#2295) * feat: add template * feat: Unkey FastAPI boilerplate (#2307) * feat: add template * feat: follow unkey on X (#2357) * Update 6_record_onboarding.md (#2301) * fix: reset input fields in API delete dialog after reopening (#2316) * fix: reset input fields in API delete dialog after reopening * refactor: remove unnecessary useEffect and utilize existing onOpenChange function for dialog * refactor: removed unused imports * Update 3_follow_the_unkey_x_account.md (#2364) Added name to the followed list. Co-authored-by: Andreas Thomas <dev@chronark.com> * ci: add label * feat: add hover to input fields * Added gaps and width for md (#2371) * docs: update overview.mdx (#2384) avaliable -> available * oss.gg side quest 3_follow_the_unkey_x_account.md (#2399) Followed the unkey x account * feat: Following unkey acc on twitter #2407 (#2408) * Feat: Followed Unkey on X * Feat: Followed Unkey on Twitter --------- Co-authored-by: Andreas Thomas <dev@chronark.com> * resolve merge conflicts * resolve merge conflicts --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: chronark <dev@chronark.com> Co-authored-by: Emily Marie Ahtúnan <86572370+Emmarie-Ahtunan@users.noreply.github.com> Co-authored-by: Harsh Shrikant Bhat <90265455+harshsbhat@users.noreply.github.com> Co-authored-by: Aritra Sadhukhan <60315087+aritradevelops@users.noreply.github.com> Co-authored-by: Flo <53355483+Flo4604@users.noreply.github.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Devang Rakholiya <116096508+Devang0907@users.noreply.github.com> Co-authored-by: Prabin <42871240+prabincankod@users.noreply.github.com> Co-authored-by: ZiaCodes <72739794+Khaan25@users.noreply.github.com> Co-authored-by: Devansh Baghel <77718741+Devansh-Baghel@users.noreply.github.com> Co-authored-by: Shreenarayan jaiswal <127131074+shreenarayan123@users.noreply.github.com> Co-authored-by: Your Name <you@example.com> Co-authored-by: Chirag Arora <chirag8023@gmail.com> Co-authored-by: Nazar Poshtarenko <32395926+unrenamed@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Saketh Pavan Goti <44170829+Sakethpavan@users.noreply.github.com> Co-authored-by: Teddy ASSIH <110066080+Ionfinisher@users.noreply.github.com> Co-authored-by: Vardhaman Bhandari <97441447+Vardhaman619@users.noreply.github.com> Co-authored-by: Atharva_404 <72994819+Atharva-3000@users.noreply.github.com> Co-authored-by: Rishi <rishipatel0826@gmail.com> Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com> Co-authored-by: Ayan Mondal <ayanmondal1805@gmail.com> Co-authored-by: Kunal Arya <105645118+kunalarya873@users.noreply.github.com>
What does this PR do?
avaliable -> available
Type of change
Checklist
Required
pnpm buildpnpm fmtconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit
MetricsandEncryptionimplementation.