Skip to content

Context7 Platform -- Up-to-date docs for AI agents

docs: add dashboard documentation and images

enesgules10dc97be33f5
diff --git a/docs/dashboard/api-keys.mdx b/docs/dashboard/api-keys.mdx
new file mode 100644
index 00000000..b217e949
--- /dev/null
+++ b/docs/dashboard/api-keys.mdx
@@ -0,0 +1,44 @@
+---
+title: API Keys
+description: Create and manage API keys for Context7 authentication
+---
+
+API keys authenticate your requests to Context7's documentation services.
+
+## Managing API Keys
+
+![API Keys card showing list of keys with details](/images/dashboard/api-keys-card.png)
+
+### Creating API Keys
+
+Generate a new API key in four simple steps:
+
+1. **Click "Create API Key"** in the API Keys card
+2. **Enter a name** (optional but recommended)
+ - Use descriptive names: "Cursor", "Claude", "VS Code", "Windsurf"
+ - Helps you identify keys later
+3. **Copy the key immediately**
+ - Keys are shown only once for security
+ - Format: `ctx7sk-**********************`
+4. **Use in your requests or add to your MCP configuration**:
+
+```bash
+curl "https://context7.com/api/v1/vercel/next.js" \
+ -H "Authorization: Bearer YOUR_API_KEY"
+```
+
+<Warning>
+Store your API key securely. You won't be able to see it again after creation.
+</Warning>
+
+### Revoking Keys
+
+Remove API keys you no longer need:
+
+1. **Click the delete button** next to the key
+2. **Confirm deletion** in the modal
+3. **Key deactivates immediately** - all requests using it will fail
+
+<Note>
+Revoking a key is permanent and cannot be undone. Update any applications using the key before revoking.
+</Note>
diff --git a/docs/dashboard/billing.mdx b/docs/dashboard/billing.mdx
new file mode 100644
index 00000000..22d558db
--- /dev/null
+++ b/docs/dashboard/billing.mdx
@@ -0,0 +1,39 @@
+---
+title: Billing & Payments
+description: Manage payment methods and subscriptions
+---
+
+Add payment methods and manage your Context7 subscription in the [billing page](https://context7.com/dashboard/billing).
+
+![Billing page showing payment methods card and management options](/images/dashboard/billing-page.png)
+
+You can access the billing page from the dropdown menu in the top left corner of the dashboard.
+
+![Billing page dropdown menu](/images/dashboard/billing-dropdown.png)
+
+## Payment Methods
+
+### Adding a Payment Method
+
+1. Click "Add payment method"
+2. Enter card details in Stripe form
+3. Complete 3D Secure if required
+4. Card appears in your list
+
+![Add payment method modal](/images/dashboard/add-payment-method.png)
+
+<Note>
+Your full card details are never stored by Context7. All payment data is handled securely by Stripe.
+</Note>
+
+### Managing Cards
+
+**Set Default**: You can set a default card to be charged for future payments.
+
+**Remove**: You can remove a card by clicking the delete icon.
+
+![Manage cards modal](/images/dashboard/manage-cards.png)
+
+## Plans
+
+To learn more about our plans and see FAQ, visit [Plans](/plans-pricing).
\ No newline at end of file
diff --git a/docs/dashboard/libraries.mdx b/docs/dashboard/libraries.mdx
new file mode 100644
index 00000000..c518df45
--- /dev/null
+++ b/docs/dashboard/libraries.mdx
@@ -0,0 +1,34 @@
+---
+title: Library Access
+description: Configure which libraries your team can access and set token limits
+---
+
+Control which public libraries your team can access and configure maximum token limits for API requests from the [libraries tab](https://context7.com/dashboard?tab=libraries).
+
+## Public Library Access
+
+![Public Library Access card](/images/dashboard/library-access-card.png)
+
+Choose who can access public libraries:
+
+![Library access options](/images/dashboard/library-access-selector.png)
+
+**All Sources** (Default): Access to all public libraries, including future additions
+
+**Select Specific**: Choose individual libraries or organizations
+
+**Disable Public**: Private repos only (requires at least one private repo)
+
+<Note>
+Only owners and admins can change these settings.
+</Note>
+
+## Token Limits
+
+![Token Limits card](/images/dashboard/token-limit-card.png)
+
+Set maximum tokens per API request: **1,000 to 100,000** to limit the amount of documentation retrieved to prevent filling the context window of LLMs with too much documentation.
+
+<Note>
+For private repositories, see the [Private Repositories](/dashboard/private-repositories) page.
+</Note>
diff --git a/docs/dashboard/private-repositories.mdx b/docs/dashboard/private-repositories.mdx
new file mode 100644
index 00000000..c9c661d2
--- /dev/null
+++ b/docs/dashboard/private-repositories.mdx
@@ -0,0 +1,90 @@
+---
+title: Private Repositories
+description: Add and manage private repository documentation
+---
+
+Add your private GitHub, GitLab, or Bitbucket repositories to Context7 to make your internal documentation available to AI coding assistants.
+
+![Private Repositories card showing a table of added repositories](/images/dashboard/private-repos-card.png)
+
+## Adding Private Repositories
+
+Follow these steps to add a private repository:
+
+1. Go to the [Add Library](https://context7.com/add-library) page
+2. **Connect your account**
+ - Choose GitHub, GitLab, or Bitbucket
+ - Authorize Context7 to access your repositories
+3. **Select repository** from your account
+5. **Submit** for parsing
+
+<Note>
+You must have Pro or Enterprise plan to add private repositories.
+</Note>
+
+## Repository Management
+
+### Refreshing Documentation
+
+Keep your private documentation up to date:
+
+1. **Click "Refresh"** next to the repository
+2. Context7 re-parses the repository
+3. **You're only charged for changed content** - cached pages are free
+
+**When to refresh**:
+- After major documentation updates
+- After releasing new features
+- When you notice outdated information
+
+<Tip>
+Refresh private repos only after significant documentation changes to minimize costs.
+</Tip>
+
+### Removing Repositories
+
+To remove a private repository:
+
+1. **Click "Remove"** next to the repository
+2. **Confirm deletion** in the modal
+3. Repository documentation becomes unavailable immediately
+
+<Warning>
+This action is permanent. The repository will no longer be accessible via the API.
+</Warning>
+
+## Permissions
+
+Access to private repository management is restricted by role:
+
+| Action | Owner | Admin | Developer |
+|--------|-------|-------|-----------|
+| View repositories | ✓ | ✓ | ✓ |
+| Add repositories | ✓ | ✓ | ✗ |
+| Refresh repositories | ✓ | ✓ | ✗ |
+| Remove repositories | ✓ | ✓ | ✗ |
+
+Developers can view repository documentation but cannot manage repositories.
+
+## Configuration
+
+### Using `context7.json`
+
+Add a `context7.json` file to your repository root for better control over parsing:
+
+```json
+{
+ "$schema": "https://context7.com/schema/context7.json",
+ "projectTitle": "Your Project Name",
+ "description": "Brief description of your project",
+ "folders": ["docs", "guides"],
+ "excludeFolders": ["tests", "dist", "node_modules"],
+ "excludeFiles": ["CHANGELOG.md"],
+ "rules": [
+ "Always validate user input",
+ "Use TypeScript strict mode"
+ ]
+}
+```
+
+See the [Adding Libraries](/adding-libraries) page for complete configuration options.
diff --git a/docs/dashboard/team.mdx b/docs/dashboard/team.mdx
new file mode 100644
index 00000000..68beca21
--- /dev/null
+++ b/docs/dashboard/team.mdx
@@ -0,0 +1,69 @@
+---
+title: Team Management
+description: Invite members and manage team permissions
+---
+
+Add team members, assign roles, and manage access to your Context7 dashboard from the [members tab](https://context7.com/dashboard?tab=members).
+
+![Members tab displaying team members list with owner, admins, and developers](/images/dashboard/members-tab.png)
+
+## Creating a Team
+
+![Create team dropdown](/images/dashboard/create-team-dropdown.png)
+
+1. Click "Create a team" from the top left dropdown
+2. Enter team name
+
+<Note>
+You must have Pro or Enterprise plan to create a team.
+</Note>
+
+## Roles
+
+| Permission | Owner | Admin | Developer |
+|------------|-------|-------|-----------|
+| View dashboard | ✓ | ✓ | ✓ |
+| Create API keys | ✓ | ✓ | ✓ |
+| Manage team members | ✓ | ✓ | ✗ |
+| Manage library access | ✓ | ✓ | ✗ |
+| Manage private repos | ✓ | ✓ | ✗ |
+| Rename team | ✓ | ✗ | ✗ |
+| Delete team | ✓ | ✗ | ✗ |
+
+## Inviting Members
+
+1. Enter member email
+2. Select role (Developer or Admin)
+3. Click "Add"
+4. Member receives invitation email
+5. Once they sign in, they are automatically added to the team
+
+<Note>
+They will remain as a pending invitation until they sign in.
+</Note>
+
+## Team Settings
+
+If you are the owner of the team, you can rename or delete the team under the overview tab.
+
+![Team management card](/images/dashboard/team-management-card.png)
+
+<Warning>
+Deleting a team is permanent. All members lose access immediately.
+</Warning>
+
+## Billing
+
+**Pro Plan**: $7 per member per month
+
+Example: Owner + 3 members = $28/month
+
+See [Billing](/dashboard/billing) for payment management.
+
+## Limits
+
+| Plan | Max Members |
+|------|-------------|
+| Free | 1 (personal only) |
+| Pro | 20 |
+| Enterprise | Unlimited |
diff --git a/docs/dashboard/usage.mdx b/docs/dashboard/usage.mdx
new file mode 100644
index 00000000..401f0eb8
--- /dev/null
+++ b/docs/dashboard/usage.mdx
@@ -0,0 +1,62 @@
+---
+title: Usage Statistics
+description: Monitor your Context7 API usage and track costs
+---
+
+Track your Context7 usage with real-time metrics from the Overview tab.
+
+![Usage statistics card showing metrics and cost breakdown](/images/dashboard/usage-stats.png)
+
+## Metrics Overview
+
+Context7 tracks four key metrics to help you understand your usage patterns:
+
+### Search & Query Requests
+
+The total number of API calls made to Context7:
+- **Search Requests**: Library search queries
+- **Query Requests**: Documentation retrieval calls
+
+### Query Tokens
+
+The total number of tokens returned in API responses. This reflects how much documentation content you've retrieved.
+
+<Tip>
+Search requests, Query requests, and Query tokens do not affect cost.
+</Tip>
+
+### Parsing Tokens
+
+The total tokens processed when parsing private repository documentation (Pro and Enterprise only).
+
+**How it works**:
+- Charged when adding a new private repository
+- Charged for changed content when refreshing
+- No charge for cached content when refreshing
+
+**Cost**: $15 per 1M tokens
+
+### Total Cost
+
+Your monthly cost in USD (Pro and Enterprise only).
+
+**Calculation**:
+```
+Total Cost = Parsing Cost + Team Cost
+
+Parsing Cost = (Parsing Tokens / 1,000,000) × $15
+Team Cost = Number of Members × $7
+```
+
+**Example**:
+- Team: 4 members
+- Parsing: 800K tokens this month
+- Cost: (800K / 1M × $15) + (4 × $7) = $12 + $28 = **$40**
+
+Hover over the Total Cost to see the detailed breakdown.
+
+## Reporting Periods
+
+**Free Plan**: Metrics display daily usage (resets every 24 hours)
+
+**Pro & Enterprise Plans**: Metrics display monthly usage (resets on your billing date)
diff --git a/docs/docs.json b/docs/docs.json
index c5878add..163e32bc 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -21,6 +21,17 @@
"api-guide"
]
},
+ {
+ "group": "Dashboard",
+ "pages": [
+ "dashboard/api-keys",
+ "dashboard/libraries",
+ "dashboard/private-repositories",
+ "dashboard/team",
+ "dashboard/usage",
+ "dashboard/billing"
+ ]
+ },
{
"group": "API Reference",
"openapi": "openapi.json"
@@ -103,10 +114,5 @@
]
}
]
- },
- "feedback": {
- "thumbsRating": true,
- "suggestEdit": true,
- "raiseIssue": true
}
}
diff --git a/docs/images/dashboard/add-payment-method.png b/docs/images/dashboard/add-payment-method.png
new file mode 100644
index 00000000..52283753
Binary files /dev/null and b/docs/images/dashboard/add-payment-method.png differ
diff --git a/docs/images/dashboard/api-keys-card.png b/docs/images/dashboard/api-keys-card.png
new file mode 100644
index 00000000..3cd39c78
Binary files /dev/null and b/docs/images/dashboard/api-keys-card.png differ
diff --git a/docs/images/dashboard/billing-dropdown.png b/docs/images/dashboard/billing-dropdown.png
new file mode 100644
index 00000000..ebf1ede7
Binary files /dev/null and b/docs/images/dashboard/billing-dropdown.png differ
diff --git a/docs/images/dashboard/billing-page.png b/docs/images/dashboard/billing-page.png
new file mode 100644
index 00000000..0eb2ec7d
Binary files /dev/null and b/docs/images/dashboard/billing-page.png differ
diff --git a/docs/images/dashboard/create-team-dropdown.png b/docs/images/dashboard/create-team-dropdown.png
new file mode 100644
index 00000000..72eb5067
Binary files /dev/null and b/docs/images/dashboard/create-team-dropdown.png differ
diff --git a/docs/images/dashboard/library-access-card.png b/docs/images/dashboard/library-access-card.png
new file mode 100644
index 00000000..666c362d
Binary files /dev/null and b/docs/images/dashboard/library-access-card.png differ
diff --git a/docs/images/dashboard/library-access-selector.png b/docs/images/dashboard/library-access-selector.png
new file mode 100644
index 00000000..69924d3c
Binary files /dev/null and b/docs/images/dashboard/library-access-selector.png differ
diff --git a/docs/images/dashboard/manage-cards.png b/docs/images/dashboard/manage-cards.png
new file mode 100644
index 00000000..5c1baee7
Binary files /dev/null and b/docs/images/dashboard/manage-cards.png differ
diff --git a/docs/images/dashboard/members-tab.png b/docs/images/dashboard/members-tab.png
new file mode 100644
index 00000000..a82fe1f8
Binary files /dev/null and b/docs/images/dashboard/members-tab.png differ
diff --git a/docs/images/dashboard/private-repos-card.png b/docs/images/dashboard/private-repos-card.png
new file mode 100644
index 00000000..36d33b43
Binary files /dev/null and b/docs/images/dashboard/private-repos-card.png differ
diff --git a/docs/images/dashboard/team-management-card.png b/docs/images/dashboard/team-management-card.png
new file mode 100644
index 00000000..44d76d80
Binary files /dev/null and b/docs/images/dashboard/team-management-card.png differ
diff --git a/docs/images/dashboard/token-limit-card.png b/docs/images/dashboard/token-limit-card.png
new file mode 100644
index 00000000..1b6b2e1e
Binary files /dev/null and b/docs/images/dashboard/token-limit-card.png differ
diff --git a/docs/images/dashboard/usage-stats.png b/docs/images/dashboard/usage-stats.png
new file mode 100644
index 00000000..4c98d7e3
Binary files /dev/null and b/docs/images/dashboard/usage-stats.png differ
diff --git a/docs/plans-pricing.mdx b/docs/plans-pricing.mdx
index a72a8dcd..652a157e 100644
--- a/docs/plans-pricing.mdx
+++ b/docs/plans-pricing.mdx
@@ -2,7 +2,11 @@
title: Plans & Pricing
---
-Choose a plan that fits your workflow today, and scale as your needs grow.
+Choose a plan that fits your workflow today, and scale as your needs grow.
+
+<Note>
+To change your plan, you can visit [context7.com/plans](https://context7.com/plans).
+</Note>
## Compare Plans