diff --git a/docs/get-started.mdx b/docs/get-started.mdx index be3037d..5eb1145 100644 --- a/docs/get-started.mdx +++ b/docs/get-started.mdx @@ -24,7 +24,7 @@ Use our API to add reputation-based context and authentication to your app, like ## Quick Start -1. [Get your API Key](/docs/api-keys) +1. [Get your API Key](/docs/talent-api/api-keys) 2. Explore our [API Reference](/docs/talent-api/api-reference) 3. Jump into specific guides: - [Authentication](/docs/talent-api/authentication) @@ -42,7 +42,7 @@ Talent is built around the following core concepts to create a comprehensive rep - [**Account**](/docs/protocol-concepts/account): A connection to a third-party data source (wallet, GitHub, X, etc.) that provides reputation data. - [**Data Point**](/docs/protocol-concepts/data-point): A specific verified fact about a builder (GitHub stars, wallet transactions, etc.). - [**Events**](/docs/protocol-concepts/event): Historical records of reputation changes -- [**Ranking Systems**](/docs/protocol-concepts/ranking-systems): A ranking system that evaluates reputation based on Data Points. Builder Rank is our primary ranking system for identifying top builders. +- [**Builder Rank**](/docs/protocol-concepts/builder-rank): Our primary ranking system that evaluates a builder's reputation based on Data Points. ## Support diff --git a/docs/legal/creator-rewards-terms-conditions.mdx b/docs/legal/creator-rewards-terms-conditions.mdx index e2e642a..1ae5815 100644 --- a/docs/legal/creator-rewards-terms-conditions.mdx +++ b/docs/legal/creator-rewards-terms-conditions.mdx @@ -44,7 +44,7 @@ The specific weights and formulas used to calculate rankings are proprietary and ## 6. Reward Distribution -Rewards are distributed automatically to eligible participants. +Rewards are distributed automatically to eligible participants. Creators will need to opt-in or opt-out of receiving rewards between September 1, 2025 and September 15, 2025 (11:59pm). If creators don’t select an option before deadline, the opt-out option will be selected as default. diff --git a/docs/protocol-concepts/account.mdx b/docs/protocol-concepts/account.mdx index 448f6ca..c656359 100644 --- a/docs/protocol-concepts/account.mdx +++ b/docs/protocol-concepts/account.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 1 --- # Account @@ -8,7 +8,7 @@ An Account represents a connection with a third-party data provider. An **Account** represents a connection with a third-party entity (e.g., Wallet Address, GitHub, X, LinkedIn) that feeds reputation data into Talent. Accounts can exist independently or be linked to a user. -A [**User**](/docs/protocol-concepts/user) represents an individual that signed up on talentprotocol.com to verify their reputation data and improve their [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank), by connecting multiple [**accounts**](/docs/protocol-concepts/account)**.** +A [**User**](/docs/protocol-concepts/user) represents an individual that signed up on talentprotocol.com to verify their reputation data and improve their [Builder Rank](/docs/protocol-concepts/builder-rank), by connecting multiple [**accounts**](/docs/protocol-concepts/account)**.** ## Key Attributes: @@ -16,8 +16,8 @@ A [**User**](/docs/protocol-concepts/user) represents an individual that signed - `talentprotocol.com/address/0xbd…23d4` - `talentprotocol.com/github/filmacedo` - If linked to a user, the account URL will automatically redirect to the user’s profile URL. Otherwise, it will show the data from that imported account independently. -- Once linked to a user, an account loses its independent profile and redirect to the user's profile. The account also loses its [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank), and its data feeds into the user's aggregated reputation. -- Accounts display their own [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank) unless linked to a user, at which point their data integrates into the user's aggregated [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank). +- Once linked to a user, an account loses its independent profile and redirect to the user's profile. The account also loses its [Builder Rank](/docs/protocol-concepts/builder-rank), and its data feeds into the user's aggregated reputation. +- Accounts display their own [Builder Rank](/docs/protocol-concepts/builder-rank) unless linked to a user, at which point their data integrates into the user's aggregated [Builder Rank](/docs/protocol-concepts/builder-rank). - Users can claim an imported account by verifying ownership (e.g., signing a wallet message, connecting GitHub). ## Types of Accounts: diff --git a/docs/protocol-concepts/ranking-systems/builder-rank.mdx b/docs/protocol-concepts/builder-rank.mdx similarity index 97% rename from docs/protocol-concepts/ranking-systems/builder-rank.mdx rename to docs/protocol-concepts/builder-rank.mdx index c9707dd..4a17bd3 100644 --- a/docs/protocol-concepts/ranking-systems/builder-rank.mdx +++ b/docs/protocol-concepts/builder-rank.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Builder Rank A ranking system to recognize real onchain builders. @@ -23,11 +27,11 @@ Builder Rank is determined by your position relative to other builders. It is ca Each Data Point is evaluated based on how strongly it signals real building activity. The exact formula is not disclosed to prevent gaming. -:::warning +::::warning Builder Rank is still experimental, so expect regular updates to the ranking algorithm. -::: +:::: ## Accessing Builder Rank @@ -37,3 +41,4 @@ You can retrieve a builder's rank via the Talent API: - [**Profile search**](/docs/talent-api/api-reference/search-for-profiles): Search and filter profiles by rank Builder Rank doesn't have a maximum cap, so rankings evolve over time as more builders join and more data sources are added. + diff --git a/docs/protocol-concepts/data-issuer.mdx b/docs/protocol-concepts/data-issuer.mdx index 3bf80b2..e45bda2 100644 --- a/docs/protocol-concepts/data-issuer.mdx +++ b/docs/protocol-concepts/data-issuer.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 3 --- # Data Issuer diff --git a/docs/protocol-concepts/data-point.mdx b/docs/protocol-concepts/data-point.mdx index 3bb7bac..4a3d7b1 100644 --- a/docs/protocol-concepts/data-point.mdx +++ b/docs/protocol-concepts/data-point.mdx @@ -37,7 +37,7 @@ Explore data indexed by Talent at [https://talent.app/~/data](https://talent.app ## Scoring Tags -- We use a **tag-based system** that determines how data points are used in [Ranking Systems](/docs/protocol-concepts/ranking-systems): +- We use a **tag-based system** that determines how data points are used in ranking systems such as [Builder Rank](/docs/protocol-concepts/builder-rank): - Initial tags: `human`, `builder`, `creator` - Data points can have multiple tags - Scoring systems use tags to determine which data points to include diff --git a/docs/protocol-concepts/human-checkmark.mdx b/docs/protocol-concepts/human-checkmark.mdx index a065687..6e6eb0e 100644 --- a/docs/protocol-concepts/human-checkmark.mdx +++ b/docs/protocol-concepts/human-checkmark.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 6 --- # Human Checkmark diff --git a/docs/protocol-concepts/profile.mdx b/docs/protocol-concepts/profile.mdx index 49941df..53c5d6b 100644 --- a/docs/protocol-concepts/profile.mdx +++ b/docs/protocol-concepts/profile.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 7 --- # Profile diff --git a/docs/protocol-concepts/ranking-systems/_category_.json b/docs/protocol-concepts/ranking-systems/_category_.json deleted file mode 100644 index be899dd..0000000 --- a/docs/protocol-concepts/ranking-systems/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Ranking Systems", - "position": 7 -} diff --git a/docs/protocol-concepts/ranking-systems/index.mdx b/docs/protocol-concepts/ranking-systems/index.mdx deleted file mode 100644 index 9a8435f..0000000 --- a/docs/protocol-concepts/ranking-systems/index.mdx +++ /dev/null @@ -1,20 +0,0 @@ -# Ranking Systems - -A Ranking System evaluates verified [Data Points](/docs/protocol-concepts/data-point) to determine a user's position relative to others in a specific domain. - -Under the hood, each ranking system uses an internal scoring algorithm to convert Data Points into a final rank. The scores themselves are not exposed — only the resulting rank is made available through the API. - -Talent intentionally separates Data Points (objective data) from Ranking Systems (subjective evaluation). Both are autonomous and composable protocol primitives. - -## Available Ranking Systems - -Multiple ranking systems can exist in parallel, each designed to evaluate talent in a specific domain: - -- [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank) identifies and ranks people creating software -- Other ranking systems coming soon - -Each ranking system operates independently with its own set of relevant Data Points, tailored to what matters for their specific persona. - -This modular approach allows Talent to serve different communities with metrics that genuinely reflect their unique contributions, rather than forcing diverse talents into the same box. - -Reach out if you want to create a custom ranking system. diff --git a/docs/protocol-concepts/socials.mdx b/docs/protocol-concepts/socials.mdx index a9a7eff..c43df15 100644 --- a/docs/protocol-concepts/socials.mdx +++ b/docs/protocol-concepts/socials.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 8 --- # Socials diff --git a/docs/protocol-concepts/user.mdx b/docs/protocol-concepts/user.mdx index ca5d6d9..9472bfd 100644 --- a/docs/protocol-concepts/user.mdx +++ b/docs/protocol-concepts/user.mdx @@ -1,12 +1,12 @@ --- -sidebar_position: 1 +sidebar_position: 9 --- # User A User represents an individual that signed up on talentprotocol.com -A **User** represents an individual that signed up on talentprotocol.com to verify their reputation data and improve their [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank), by connecting multiple [**accounts**](/docs/protocol-concepts/account)**.** +A **User** represents an individual that signed up on talentprotocol.com to verify their reputation data and improve their [Builder Rank](/docs/protocol-concepts/builder-rank), by connecting multiple [**accounts**](/docs/protocol-concepts/account)**.** An [**Account**](/docs/protocol-concepts/account) represents a connection with a third-party entity (e.g., Wallet Address, GitHub, X, LinkedIn) that feeds reputation data into Talent. Accounts can exist independently or be linked to a user. @@ -16,7 +16,7 @@ An [**Account**](/docs/protocol-concepts/account) represents a connection with a - Users have a single profile URL aggregating data from all associated accounts. - `talentprotocol.com/UUID` - A user can connect multiple [accounts](/docs/protocol-concepts/account), but an account can only be linked to one user at a time. -- A user aggregates reputation data from all its connected [accounts](/docs/protocol-concepts/account) into a unified [Builder Rank](/docs/protocol-concepts/ranking-systems/builder-rank). +- A user aggregates reputation data from all its connected [accounts](/docs/protocol-concepts/account) into a unified [Builder Rank](/docs/protocol-concepts/builder-rank). - A user is able to sign-in to the Talent App with any account that they connected. - For now, only the Talent app can create, update or delete users from the database. Ecosystem apps can only read data. diff --git a/docs/api-keys.mdx b/docs/talent-api/api-keys.mdx similarity index 94% rename from docs/api-keys.mdx rename to docs/talent-api/api-keys.mdx index 7ebec9c..c54f537 100644 --- a/docs/api-keys.mdx +++ b/docs/talent-api/api-keys.mdx @@ -2,7 +2,7 @@ id: api-keys title: API Keys sidebar_label: API Keys -sidebar_position: 3 +sidebar_position: 1 description: Manage your Talent API keys. --- @@ -12,4 +12,3 @@ API Keys are available exclusively for Talent+ members (5k requests/month). After getting your Talent+ membership on [talent.app](https://talent.app), you can request an API Key [here](https://talent.app/~/settings/api). - diff --git a/docs/talent-api/authentication.mdx b/docs/talent-api/authentication.mdx index 3be6e93..55bde04 100644 --- a/docs/talent-api/authentication.mdx +++ b/docs/talent-api/authentication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 --- # Authentication diff --git a/docs/talent-api/pagination.mdx b/docs/talent-api/pagination.mdx index 918d3d4..be9cae5 100644 --- a/docs/talent-api/pagination.mdx +++ b/docs/talent-api/pagination.mdx @@ -1,4 +1,5 @@ --- +sidebar_position: 3 --- # Pagination diff --git a/docs/talent-api/rate-limits.mdx b/docs/talent-api/rate-limits.mdx index fb775b8..7b67815 100644 --- a/docs/talent-api/rate-limits.mdx +++ b/docs/talent-api/rate-limits.mdx @@ -1,4 +1,5 @@ --- +sidebar_position: 4 --- # Rate Limits