Merge pull request #14 from trophyso/streak-freezes-docs

Update leaderboard asset

Author: cbrinicombe13

.github/workflows/check-link-rot.yml

@@ -0,0 +1,32 @@
+# Top level styles
+StylesPath = styles
+MinAlertLevel = suggestion
+IgnoredScopes = code, tt, img, url, a, em, strong, code
+SkippedScopes = script, style, pre, figure, code
+
+# Vocabularies
+Vocab = Mintlify, Trophy
+
+# This is required since Vale doesn't officially support MDX
+[formats]
+mdx = md
+
+# MDX support
+[*.mdx]
+BasedOnStyles = Vale
+Vale.Terms = NO # Enforces really harsh capitalization rules, keep off
+
+# `import ...`, `export ...`
+# `<Component ... />`
+# `<Component>...</Component>`
+# `{ ... }`
+TokenIgnores = (?sm)((?:import|export) .+?$), \
+(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
+(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
+
+# Exclude:
+# `<Component \n ... />`
+BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
+(?sm)^({.+.*})
+
+CommentDelimiters = {/*, */}

.vale.ini

@@ -21,7 +21,7 @@ Trophy defines an MAU as a single user that is involved in at least one API call
 
 ## Free tier
 
-All customers start on the free tier. This allows dev teams to build and test implementations for up to **100 MAUs** without accurring any usage charges.
+All customers start on the free tier. This allows dev teams to build and test implementations for up to **100 MAUs** without accruing any usage charges.
 
 <Note>
   If you exceed the free plan, don't panic! Nothing will stop working, we'll
@@ -62,7 +62,7 @@ You can view your usage for the current billing period in the [Trophy dashboard]
 
 <AccordionGroup>
   <Accordion title="When will I be charged?">
-    We charge all customers on the 1st of the month in arreas.
+    We charge all customers on the 1st of the month in arrears.
   </Accordion>
 </AccordionGroup>
 

account/billing.mdx

@@ -1,7 +1,7 @@
 ---
 title: Branding
 description: Configure your logo and brand colors used across features built with Trophy.
-"og:description": Learn how Trophy tracks usage according to the number of usres that use your product.
+"og:description": Learn how Trophy tracks usage according to the number of users that use your product.
 icon: palette
 ---
 

account/branding.mdx

@@ -17,7 +17,7 @@ Trophy keeps track of and displays when each API key in your account was created
 
 ### Anatomy of an API key
 
-Each API key is made up of 2 parts seperated by a period:
+Each API key is made up of 2 parts separated by a period:
 
 ```bash
 {prefix}•{body}
@@ -64,7 +64,7 @@ API keys can be rotated if you want to change them for any reason. At the point
 
 ### Revoking keys
 
-API keys can also be revoked entirely at which point they become _Inactive_. At the point of revokation, the API key will no longer function and any requests still using it will begin receiving `401` responses immediately.
+API keys can also be revoked entirely at which point they become _Inactive_. At the point of revocation, the API key will no longer function and any requests still using it will begin receiving `401` responses immediately.
 
 Once revoked you can re-activate the API key at any time.
 

api-reference/authentication.mdx

@@ -41,11 +41,13 @@ When Trophy detects an idempotency key has been sent with an event, it will firs
 <Note>
   All Trophy [metrics](/platform/metrics) manage idempotency in isolation.
   Trophy will accept a user using the same idempotency key for events against
-  different metrics as seperate isolated requests.
+  different metrics as separate isolated requests.
 </Note>
 
 Additionally, when using an idempotency key the response will contain two properties to help clients manage replayed requests effectively:
 
+{/* vale off */}
+
 ```json
 {
     ...,
@@ -54,9 +56,11 @@ Additionally, when using an idempotency key the response will contain two proper
 }
 ```
 
+{/* vale on */}
+
 <Note>
-  By default Trophy uses an infinte time window for detecting duplicate events.
-  If you feel you need different behavoir, please [get in
+  By default Trophy uses an infinite time window for detecting duplicate events.
+  If you feel you need different behavior, please [get in
   touch](mailto:support@trophy.so) and we'll happily set that up for you.
 </Note>
 

api-reference/idempotency.mdx

@@ -11,7 +11,7 @@ A key part of running a gamified platform is experimentation — tweaking and op
 Usually, you'd have to build these tools yourself, but with Trophy you get an experimentation stack out-of-the-box.
 
 <Note>
-  We have plans to extend Trophy's experimentation capibilities in the future to
+  We have plans to extend Trophy's experimentation capabilities in the future to
   support more broad A/B testing of your gamification features.
 </Note>
 

assets/platform/leaderboards/hero.png

@@ -110,7 +110,7 @@ Here you'll integrate your backend web application with Trophy and start buildin
         Create friendly competitions to increase user engagement.
       </Card>
       <Card title="Emails" icon="mail" href="/platform/emails">
-        Deliver personalized lifecyle emails to users at the perfect moment.
+        Deliver personalized lifecycle emails to users at the perfect moment.
       </Card>
     </CardGroup>
 

experimentation/overview.mdx

@@ -72,7 +72,7 @@ Would you like to use Turbopack for `next dev`?  Yes
 Would you like to customize the import alias (`@/*` by default)? No
 ```
 
-Next, we'll initialize a new install of everyones favourite UI library, shadcn/ui:
+Next, we'll initialize a new install of everyone's favourite UI library, shadcn/ui:
 
 ```bash
 npx shadcn@latest init
@@ -458,7 +458,7 @@ export default function Flashcard({ flashcard }: Props) {
 
 You'll notice we also added a couple of styles here. These do a couple of things:
 
-- Ensure that when a `<Card />` is flipping, the 'backface' isn't visible during the animation with `backface-visibility: hidden;`
+- Ensure that when a `<Card />` is flipping, the 'back face' isn't visible during the animation with `backface-visibility: hidden;`
 - As the `<Card />` component is a child of the `<motion.div />`, usually it would appear flat when it's parent rotates in 3D. Adding `transform-style: preserve-3d;` to the `<Card />` ensures it keeps it's 3D effect when it's parent animates.
 
 ```css src/app/flashcard.module.css
@@ -683,7 +683,7 @@ In this section we'll be adding the following gamification elements to the flash
   - Achievement unlocked
   - Weekly progress summaries
 
-This might sound like a lot, but would you be surprised if I told you you could build all this in less than 10 lines of code?
+This might sound like a lot, but would you be surprised if I told you could build all this in less than 10 lines of code?
 
 Yup, you can. Trophy makes it super easy to build these features with a few lines of integration code.
 
@@ -1178,7 +1178,7 @@ To see this in action, all we need to do is unlock our first achievement by view
 
 #### Streak Extended Toasts
 
-We'll use the same methods to show similar toasts when a user extendeds their streak. As we've set up a daily streak in Trophy, this will trigger the first time a user views a flashcard each day.
+We'll use the same methods to show similar toasts when a user extends their streak. As we've set up a daily streak in Trophy, this will trigger the first time a user views a flashcard each day.
 
 <Tip>
   If we wanted to experiment with a different streak cadence, like a weekly
@@ -1407,9 +1407,9 @@ export default function Flashcards({ flashcards }: Props) {
 
 #### Displaying Study Journey
 
-The last peice of UI we'll add will be a dialog to display the user's study progress, including their streak and any achievements they've unlocked so far.
+The last piece of UI we'll add will be a dialog to display the user's study progress, including their streak and any achievements they've unlocked so far.
 
-First, we'll add a couple of new server actions to fetch the users streak and achievements from Trophy. As we're using a daily sterak here, we'll fetch the last 14 days of streak data from Trophy to give us enough to work with in our UI:
+First, we'll add a couple of new server actions to fetch the users streak and achievements from Trophy. As we're using a daily streak here, we'll fetch the last 14 days of streak data from Trophy to give us enough to work with in our UI:
 
 ```tsx src/app/actions.ts [expandable] {6-7,10-11,24,33,45-58,60-73}
 "use server";