From 68ba986c57affe84e1fb9893cea8a550abd917c1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 23 May 2026 08:44:08 +0000 Subject: [PATCH] docs: improve SEO descriptions across English docs pages --- account/billing.mdx | 2 +- account/branding.mdx | 2 +- account/members.mdx | 2 +- account/overview.mdx | 2 +- admin-api/authentication.mdx | 3 +-- admin-api/client-libraries.mdx | 2 +- admin-api/introduction.mdx | 3 +-- admin-api/rate-limiting.mdx | 2 +- api-reference/authentication.mdx | 3 +-- api-reference/client-libraries.mdx | 2 +- api-reference/idempotency.mdx | 3 +-- api-reference/introduction.mdx | 2 +- api-reference/rate-limiting.mdx | 2 +- features/achievements.mdx | 2 +- features/emails.mdx | 2 +- features/events.mdx | 3 +-- features/leaderboards.mdx | 2 +- features/overview.mdx | 2 +- features/points.mdx | 2 +- features/push-notifications.mdx | 3 +-- features/streaks.mdx | 2 +- features/users.mdx | 2 +- getting-started/introduction.mdx | 2 +- getting-started/quickstart.mdx | 2 +- guides/gamified-study-platform.mdx | 3 +-- guides/how-to-build-a-leaderboards-feature.mdx | 3 +-- guides/how-to-build-a-streaks-feature.mdx | 2 +- guides/how-to-build-an-achievements-feature.mdx | 3 +-- guides/how-to-build-an-energy-feature.mdx | 2 +- guides/how-to-build-an-xp-feature.mdx | 2 +- platform/environments.mdx | 2 +- platform/experimentation.mdx | 3 +-- platform/multi-tenancy.mdx | 2 +- platform/overview.mdx | 2 +- uikit/overview.mdx | 1 + webhooks/idempotency.mdx | 3 +-- webhooks/introduction.mdx | 3 +-- webhooks/observability.mdx | 2 +- webhooks/quickstart.mdx | 2 +- webhooks/retries.mdx | 2 +- webhooks/security.mdx | 2 +- 41 files changed, 41 insertions(+), 52 deletions(-) diff --git a/account/billing.mdx b/account/billing.mdx index 81f6402..c385462 100644 --- a/account/billing.mdx +++ b/account/billing.mdx @@ -1,6 +1,6 @@ --- title: Billing -description: Learn how Trophy controls costs by charging based on monthly active users. +description: "Understand Trophy's usage-based billing model, monthly active user pricing, free tier limits, and how the Starter and Pro plans compare." og:description: Learn how Trophy controls costs by charging based on monthly active users. icon: gauge --- diff --git a/account/branding.mdx b/account/branding.mdx index c84a812..6a4efb5 100644 --- a/account/branding.mdx +++ b/account/branding.mdx @@ -1,6 +1,6 @@ --- title: Branding -description: Configure your logo and brand colors used across features built with Trophy. +description: "Configure your account logo, fonts, brand color, app name, and app URL so Trophy emails and notifications match your product's visual identity." og:description: Learn how Trophy tracks usage according to the number of users that use your product. icon: palette diff --git a/account/members.mdx b/account/members.mdx index 37fb02e..16fc503 100644 --- a/account/members.mdx +++ b/account/members.mdx @@ -1,6 +1,6 @@ --- title: Members -description: Give team members access to Trophy and manage your account settings. +description: "Invite team members to your Trophy organization, manage admin and member roles, and control access to account settings from the dashboard." og:description: Give team members access to Trophy and manage your account settings. icon: user-plus --- diff --git a/account/overview.mdx b/account/overview.mdx index ad24a00..1ba7887 100644 --- a/account/overview.mdx +++ b/account/overview.mdx @@ -1,6 +1,6 @@ --- title: Overview -description: Learn how to manage your Trophy account. +description: "Manage your Trophy organization, including team members, branding for emails and notifications, and usage-based billing for monthly active users." --- From inviting team members to understanding billing, this section of the documentation is dedicated to managing your Trophy account. diff --git a/admin-api/authentication.mdx b/admin-api/authentication.mdx index 9fc846d..69d1d78 100644 --- a/admin-api/authentication.mdx +++ b/admin-api/authentication.mdx @@ -1,7 +1,6 @@ --- title: Authentication -description: Integrate securely with the API using account-level API keys - transmitted in the `X-API-KEY` header. +description: "Authenticate Admin API requests with account-level API keys passed in the X-API-KEY header, using the same credentials as the Application API." og:description: Integrate securely with the Trophy API using account-level API keys transmitted in the `X-API-KEY` header. icon: key diff --git a/admin-api/client-libraries.mdx b/admin-api/client-libraries.mdx index e038f08..6dd2eab 100644 --- a/admin-api/client-libraries.mdx +++ b/admin-api/client-libraries.mdx @@ -1,6 +1,6 @@ --- title: Client Libraries -description: Use Trophy's type-safe SDKs to integrate with the API. +description: "Call the Trophy Admin API from Node.js, Python, Go, and other languages using the official type-safe SDKs under the trophy.admin namespace." og:description: Use Trophy's type-safe SDKs to integrate with the API and start building gamified product experiences. icon: code-xml diff --git a/admin-api/introduction.mdx b/admin-api/introduction.mdx index d581555..a5d9307 100644 --- a/admin-api/introduction.mdx +++ b/admin-api/introduction.mdx @@ -1,7 +1,6 @@ --- title: Introduction -description: Learn about the Trophy Admin API and how to use it to drive custom - workflows using Trophy data. +description: "Build custom gamification workflows with the Trophy Admin API, a set of endpoints for managing metrics, points, leaderboards, attributes, and tenants." subtitle: Learn about the Trophy Admin API and how to use it to drive custom workflows using Trophy data. --- diff --git a/admin-api/rate-limiting.mdx b/admin-api/rate-limiting.mdx index 7c800f6..df324f5 100644 --- a/admin-api/rate-limiting.mdx +++ b/admin-api/rate-limiting.mdx @@ -1,6 +1,6 @@ --- title: Rate Limiting -description: Learn about the Trophy API and request rate limiting. +description: "Understand the request rate limits applied to every Trophy Admin API endpoint, the tier model used, and how to handle 429 Too Many Requests responses." og:description: Learn about the Trophy API and request rate limiting. icon: circle-gauge --- diff --git a/api-reference/authentication.mdx b/api-reference/authentication.mdx index 0c3cca9..f27da09 100644 --- a/api-reference/authentication.mdx +++ b/api-reference/authentication.mdx @@ -1,7 +1,6 @@ --- title: Authentication -description: Integrate securely with the API using account-level API keys - transmitted in the `X-API-KEY` header. +description: "Authenticate Trophy Application API requests with account-level API keys sent in the X-API-KEY header, and learn how to manage keys for each environment." og:description: Integrate securely with the Trophy API using account-level API keys transmitted in the `X-API-KEY` header. icon: key diff --git a/api-reference/client-libraries.mdx b/api-reference/client-libraries.mdx index 3cc65d8..5de293d 100644 --- a/api-reference/client-libraries.mdx +++ b/api-reference/client-libraries.mdx @@ -1,6 +1,6 @@ --- title: Client Libraries -description: Use Trophy's type-safe SDKs to integrate with the API. +description: "Integrate the Trophy Application API from Node.js, Python, Go, Ruby, and other languages using the official type-safe SDKs and client libraries." og:description: Use Trophy's type-safe SDKs to integrate with the API and start building gamified product experiences. icon: code-xml diff --git a/api-reference/idempotency.mdx b/api-reference/idempotency.mdx index c2b1807..0df49ae 100644 --- a/api-reference/idempotency.mdx +++ b/api-reference/idempotency.mdx @@ -1,7 +1,6 @@ --- title: Idempotency -description: Prevent unintended side effects when retrying requests with - idempotency controls built into the Trophy API and SDKs. +description: "Use the Idempotency-Key header to safely retry Trophy Application API requests, prevent duplicate side effects, and learn which endpoints support it." og:description: Prevent unintended side effects when retrying requests with idempotency built into the Trophy API and SDKs using the `Idempotency-Key` request header. diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index fcc73f0..edb4184 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -1,6 +1,6 @@ --- title: Introduction -description: Learn about the Trophy API and get started building your integration. +description: "Start building gamification features with the Trophy Application API, the set of endpoints your app uses to track events and read user-facing data." subtitle: Learn about the Trophy API and get started building your integration. --- diff --git a/api-reference/rate-limiting.mdx b/api-reference/rate-limiting.mdx index 68f3365..e6cd98c 100644 --- a/api-reference/rate-limiting.mdx +++ b/api-reference/rate-limiting.mdx @@ -1,6 +1,6 @@ --- title: Rate Limiting -description: Learn about the Trophy API and request rate limiting. +description: "Understand the tiered rate limits on each Trophy Application API endpoint, the organisation-level quotas, and how to handle 429 Too Many Requests errors." og:description: Learn about the Trophy API and request rate limiting. icon: circle-gauge --- diff --git a/features/achievements.mdx b/features/achievements.mdx index 777fba8..7a097aa 100644 --- a/features/achievements.mdx +++ b/features/achievements.mdx @@ -1,6 +1,6 @@ --- title: Achievements -description: Learn how to use Achievements in a gamified product experience with Trophy. +description: "Reward users with one-time and metric-based achievements in Trophy, including how to configure unlock criteria, completion logic, and backdating." og:description: Use metric, API, streak and composite achievements to reward users for continued progress and to encourage them to discover new parts of your app. diff --git a/features/emails.mdx b/features/emails.mdx index e1b06e0..015e5c7 100644 --- a/features/emails.mdx +++ b/features/emails.mdx @@ -1,6 +1,6 @@ --- title: Emails -description: Learn how to use emails in a gamified product experience with Trophy. +description: "Send transactional and lifecycle emails for streaks, achievements, points, and leaderboards using Trophy's built-in templates and branding controls." og:description: Use automated email flows to extend your gamification experience outside your app and remind users to keep coming back. icon: mail diff --git a/features/events.mdx b/features/events.mdx index ad545aa..9595c6b 100644 --- a/features/events.mdx +++ b/features/events.mdx @@ -1,7 +1,6 @@ --- title: Events -description: Events are data objects that represent individual user interactions - against metrics in Trophy. +description: "Send metric events to Trophy to represent user interactions, drive achievements, streaks, points, and leaderboards, and power gamified product flows." og:description: Events are data objects that represent individual user interactions against metrics in Trophy. icon: radio diff --git a/features/leaderboards.mdx b/features/leaderboards.mdx index ebf05e2..9516842 100644 --- a/features/leaderboards.mdx +++ b/features/leaderboards.mdx @@ -1,6 +1,6 @@ --- title: Leaderboards -description: Learn how to use Leaderboards in a gamified product experience with Trophy. +description: "Configure ranked, time-bound leaderboards in Trophy to drive competition between users, with support for custom scoring, tenants, and user attributes." og:description: Create daily, weekly or monthly competitions that rank users based on metrics, points or streaks and increase user engagement. icon: /icons/leaderboard.svg diff --git a/features/overview.mdx b/features/overview.mdx index d6705c7..79133ed 100644 --- a/features/overview.mdx +++ b/features/overview.mdx @@ -1,6 +1,6 @@ --- title: Overview -description: Learn the key concepts behind Trophy's gamification system. +description: "Understand the core Trophy concepts behind gamification, including metrics, events, achievements, streaks, points, and leaderboards, and how they connect." og:description: Learn the key concepts behind Trophy's gamification system including Metrics, Events, Achievements and Streaks. --- diff --git a/features/points.mdx b/features/points.mdx index d6c92cc..f1215b5 100644 --- a/features/points.mdx +++ b/features/points.mdx @@ -1,6 +1,6 @@ --- title: Points -description: Learn how to build points-based systems using Trophy +description: "Design points systems in Trophy with custom triggers, levels, and boosts to power XP-style progression, currencies, and reward loops in your product." og:description: Use points systems to reward users for in-app actions. icon: sparkle --- diff --git a/features/push-notifications.mdx b/features/push-notifications.mdx index 225a60f..bff8367 100644 --- a/features/push-notifications.mdx +++ b/features/push-notifications.mdx @@ -1,7 +1,6 @@ --- title: Push Notifications -description: Learn how to use push notifications in a gamified product - experience with Trophy. +description: "Send mobile push notifications for streaks, achievements, points, and leaderboards in Trophy, including device token management and delivery options." og:description: Use automated push notification flows to extend your gamification experience outside your app and remind users to keep coming back. icon: bell diff --git a/features/streaks.mdx b/features/streaks.mdx index 697cdc8..340d2be 100644 --- a/features/streaks.mdx +++ b/features/streaks.mdx @@ -1,6 +1,6 @@ --- title: Streaks -description: Learn how to use streaks in a gamified product experience with Trophy. +description: "Build daily, weekly, and custom streaks in Trophy to drive habit formation, with support for freezes, restores, and timezone-aware streak tracking." og:description: Use daily, weekly or monthly streaks to create habitual usage patterns and keep users coming back to your app. icon: flame diff --git a/features/users.mdx b/features/users.mdx index 860cdcb..f18af9b 100644 --- a/features/users.mdx +++ b/features/users.mdx @@ -1,6 +1,6 @@ --- title: Users -description: Learn how to track interactions across your userbase using Trophy. +description: "Identify users in Trophy, attach custom attributes, and track interactions across your userbase to personalize gamification and segmentation in your app." og:description: Users are the people that use your platform. Learn how to tell Trophy about them. icon: users diff --git a/getting-started/introduction.mdx b/getting-started/introduction.mdx index ab57bc7..480582c 100644 --- a/getting-started/introduction.mdx +++ b/getting-started/introduction.mdx @@ -1,6 +1,6 @@ --- title: Welcome to Trophy -description: Trophy documentation for gamification APIs, quickstart guides and tutorials. +description: "Explore Trophy's documentation for gamification APIs, including quickstart guides, feature overviews, SDK references, and end-to-end tutorials." --- Trophy is a developer-friendly toolkit for building gamified product experiences in any mobile or web app. diff --git a/getting-started/quickstart.mdx b/getting-started/quickstart.mdx index 46d24e8..388485a 100644 --- a/getting-started/quickstart.mdx +++ b/getting-started/quickstart.mdx @@ -1,6 +1,6 @@ --- title: Quick Start -description: Get up and running with Trophy in under 10 minutes +description: "Integrate Trophy into your backend in under 10 minutes by creating an account, adding the SDK, identifying users, and tracking your first metric event." og:description: Follow this quick start guide to integrate Trophy into your backend and add gamified features like achievements and streaks into your app. --- diff --git a/guides/gamified-study-platform.mdx b/guides/gamified-study-platform.mdx index 88728f8..467d77c 100644 --- a/guides/gamified-study-platform.mdx +++ b/guides/gamified-study-platform.mdx @@ -1,7 +1,6 @@ --- title: How to Build a Gamified Study Platform -description: Follow along as we build out a gamified study platform using Trophy - with achievements, a daily streak, XP and leaderboards. +description: "Build a gamified study platform with Trophy that combines achievements, daily streaks, XP progression, and leaderboards to keep learners engaged." subtitle: Follow along as we build out a gamified study platform using Trophy. noindex: true --- diff --git a/guides/how-to-build-a-leaderboards-feature.mdx b/guides/how-to-build-a-leaderboards-feature.mdx index c20f6bb..984ef86 100644 --- a/guides/how-to-build-a-leaderboards-feature.mdx +++ b/guides/how-to-build-a-leaderboards-feature.mdx @@ -1,7 +1,6 @@ --- title: How To Build A Leaderboards Feature -description: Learn how to use Trophy to add a leaderboards feature to your web - or mobile app. +description: "Add a competitive leaderboards feature to your web or mobile app with Trophy, including ranking logic, time windows, tenants, and UI integration." subtitle: Learn how to use Trophy to add a leaderboards feature to your web or mobile app. noindex: true diff --git a/guides/how-to-build-a-streaks-feature.mdx b/guides/how-to-build-a-streaks-feature.mdx index 3cd7d46..86c24d9 100644 --- a/guides/how-to-build-a-streaks-feature.mdx +++ b/guides/how-to-build-a-streaks-feature.mdx @@ -1,6 +1,6 @@ --- title: How To Build A Streaks Feature -description: Learn how to use Trophy to add a streaks feature to your web or mobile app. +description: "Add a daily streaks feature to your web or mobile app with Trophy, including streak tracking, freezes, restores, and timezone-aware completion logic." subtitle: Learn how to use Trophy to add a streaks feature to your web or mobile app. noindex: true --- diff --git a/guides/how-to-build-an-achievements-feature.mdx b/guides/how-to-build-an-achievements-feature.mdx index d29ef3f..f962bad 100644 --- a/guides/how-to-build-an-achievements-feature.mdx +++ b/guides/how-to-build-an-achievements-feature.mdx @@ -1,7 +1,6 @@ --- title: How To Build An Achievements Feature -description: Learn how to use Trophy to add an achievements feature to your web - or mobile app. +description: "Add an achievements feature to your web or mobile app with Trophy, including metric-based unlocks, one-time achievements, and completion notifications." subtitle: Learn how to use Trophy to add an achievements feature to your web or mobile app. noindex: true diff --git a/guides/how-to-build-an-energy-feature.mdx b/guides/how-to-build-an-energy-feature.mdx index 48ed6f5..09d2c95 100644 --- a/guides/how-to-build-an-energy-feature.mdx +++ b/guides/how-to-build-an-energy-feature.mdx @@ -1,6 +1,6 @@ --- title: How To Build An Energy Feature -description: Learn how to use Trophy to add an energy feature to your web or mobile app. +description: "Add an energy or stamina feature to your web or mobile app with Trophy, modeling consumable resources that regenerate over time using points systems." subtitle: Learn how to use Trophy to add an energy feature to your web or mobile app. noindex: true --- diff --git a/guides/how-to-build-an-xp-feature.mdx b/guides/how-to-build-an-xp-feature.mdx index a15f61a..5b2544a 100644 --- a/guides/how-to-build-an-xp-feature.mdx +++ b/guides/how-to-build-an-xp-feature.mdx @@ -1,6 +1,6 @@ --- title: How To Build An XP Feature -description: Learn how to use Trophy to add an XP feature to your web or mobile app. +description: "Add an XP and leveling feature to your web or mobile app with Trophy, including points triggers, leveling curves, level summaries, and progress UI." subtitle: Learn how to use Trophy to add an XP feature to your web or mobile app. noindex: true --- diff --git a/platform/environments.mdx b/platform/environments.mdx index eb9ca73..0b29d6f 100644 --- a/platform/environments.mdx +++ b/platform/environments.mdx @@ -1,6 +1,6 @@ --- title: Environments -description: Learn how to use environments to help you test and review changes before releasing to production. +description: "Use Trophy environments to safely test and review gamification changes in staging before promoting them to production for your live users." og:description: Learn how to use environments to help you test and review changes before releasing to production. icon: layers --- diff --git a/platform/experimentation.mdx b/platform/experimentation.mdx index 7a0541e..7cdbee8 100644 --- a/platform/experimentation.mdx +++ b/platform/experimentation.mdx @@ -1,7 +1,6 @@ --- title: Experimentation -description: Learn how to use Trophy to experiment with the gamification - experience and increase retention and user engagement. +description: "Run experiments on Trophy's gamification features with control flags and audience targeting to measure their impact on retention and engagement." og:description: Learn how to use Trophy to experiment with the gamification experience and increase retention and user engagement. icon: flask-conical diff --git a/platform/multi-tenancy.mdx b/platform/multi-tenancy.mdx index cafceda..caaa2c1 100644 --- a/platform/multi-tenancy.mdx +++ b/platform/multi-tenancy.mdx @@ -1,6 +1,6 @@ --- title: Multi-Tenancy -description: Learn how to use multi-tenancy to help you set up and customize gamification features for each of your customers. +description: "Use Trophy's multi-tenancy to configure and customize gamification features per customer, with isolated data, settings, and leaderboards per tenant." og:description: Learn how to use multi-tenancy to help you set up and customize gamification features for each of your customers. icon: building --- diff --git a/platform/overview.mdx b/platform/overview.mdx index d03fe24..49fd319 100644 --- a/platform/overview.mdx +++ b/platform/overview.mdx @@ -1,6 +1,6 @@ --- title: Overview -description: Learn how to configure and operate the Trophy platform. +description: "Configure and operate the Trophy platform with environments, multi-tenancy, experimentation, and other tools for managing gamification at scale." --- From isolating data across environments to powering multi-tenant gamification and running experiments on your gamification experience, this section of the documentation covers how to configure and operate the Trophy platform. diff --git a/uikit/overview.mdx b/uikit/overview.mdx index 66b71d7..22e44f8 100644 --- a/uikit/overview.mdx +++ b/uikit/overview.mdx @@ -1,5 +1,6 @@ --- title: Gamification UI Kit +description: "Ship gamification UI faster with Trophy's shadcn/ui-based component library for streaks, achievements, points, leaderboards, and more in React apps." --- diff --git a/webhooks/idempotency.mdx b/webhooks/idempotency.mdx index 084c019..7de1731 100644 --- a/webhooks/idempotency.mdx +++ b/webhooks/idempotency.mdx @@ -1,7 +1,6 @@ --- title: Idempotency -description: Learn how to ensure your webhook endpoints only process events once - to prevent unintended side effects. +description: "Make your Trophy webhook handlers idempotent using event IDs to safely process duplicate deliveries and avoid unintended side effects on retries." subtitle: Learn how to ensure your webhook endpoints only process events once to prevent unintended side effects. icon: repeat diff --git a/webhooks/introduction.mdx b/webhooks/introduction.mdx index 4072384..94b055a 100644 --- a/webhooks/introduction.mdx +++ b/webhooks/introduction.mdx @@ -1,7 +1,6 @@ --- title: Introduction -description: Learn about webhooks in Trophy and how to use them to power custom - gamification integrations. +description: "Use Trophy webhooks to react to gamification events like streak changes, achievement completions, and points updates from your own backend services." subtitle: Learn about webhooks in Trophy and how to use them to power custom gamification integrations. --- diff --git a/webhooks/observability.mdx b/webhooks/observability.mdx index e198c72..b4657cc 100644 --- a/webhooks/observability.mdx +++ b/webhooks/observability.mdx @@ -1,6 +1,6 @@ --- title: Observability -description: Learn how to monitor and diagnose issues with webhook delivery. +description: "Monitor Trophy webhook delivery, inspect attempts and response codes, and diagnose failed deliveries from the dashboard to keep integrations healthy." subtitle: Learn how to monitor and diagnose issues with webhook delivery. icon: activity --- diff --git a/webhooks/quickstart.mdx b/webhooks/quickstart.mdx index c881d6b..ab6209a 100644 --- a/webhooks/quickstart.mdx +++ b/webhooks/quickstart.mdx @@ -1,6 +1,6 @@ --- title: Quick Start -description: Start receiving webhook events from Trophy in under 10 minutes. +description: "Start receiving Trophy webhook events in under 10 minutes by registering an endpoint, verifying signatures, and handling your first achievement event." subtitle: Start receiving webhook events from Trophy in under 10 minutes. icon: circle-play --- diff --git a/webhooks/retries.mdx b/webhooks/retries.mdx index cb36008..06aeba5 100644 --- a/webhooks/retries.mdx +++ b/webhooks/retries.mdx @@ -1,6 +1,6 @@ --- title: Retries -description: Learn how Trophy handles webhook retries with configured endpoints. +description: "Understand how Trophy retries failed webhook deliveries with exponential backoff, when retries stop, and how to recover after extended endpoint outages." subtitle: Learn how Trophy handles webhook retries with configured endpoints. icon: rotate-ccw --- diff --git a/webhooks/security.mdx b/webhooks/security.mdx index e899fe6..7d00ac9 100644 --- a/webhooks/security.mdx +++ b/webhooks/security.mdx @@ -1,6 +1,6 @@ --- title: Security -description: Build secure webhook endpoints using webhook signature verification. +description: "Secure your Trophy webhook endpoints by verifying request signatures with your signing secret to ensure each event came from Trophy and is untampered." subtitle: Build secure webhook endpoints using webhook signature verification. icon: shield-check ---