Skip to content

Commit 58a36ce

Browse files
authored
feat: update stale docs (upstash#2307)
1 parent 5d7e893 commit 58a36ce

23 files changed

Lines changed: 207 additions & 119 deletions

docs/adding-libraries.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The fastest way to add a library is through our web interface:
3232
3. Submit and let Context7 parse and index the documentation.
3333

3434
<Note>
35-
For private repositories, see the [Private Repositories](/howto/private-repositories) guide.
35+
For private sources, see the [Private Sources](/howto/private-sources) guide.
3636
Requires a Pro or Enterprise plan.
3737
</Note>
3838

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"howto/claiming-libraries",
4545
"howto/chat-widget",
4646
"howto/verification",
47-
"howto/private-repositories",
47+
"howto/private-sources",
4848
"howto/teamspace",
4949
"howto/usage"
5050
]
@@ -139,6 +139,7 @@
139139
{
140140
"group": "Integrations",
141141
"pages": [
142+
"integrations/github-actions",
142143
"integrations/code-rabbit"
143144
]
144145
},

docs/howto/chat-widget.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The widget is a lightweight JavaScript snippet that renders a floating chat butt
99

1010
<Note>The chat widget is available to library owners who have [claimed their library](/howto/claiming-libraries).</Note>
1111

12+
![Chat widget panel showing AI-powered documentation assistant](/images/dashboard/chat-widget.png)
13+
1214
## How It Works
1315

1416
1. A visitor clicks the chat bubble on your site

docs/howto/private-repositories.mdx

Lines changed: 0 additions & 77 deletions
This file was deleted.

docs/howto/private-sources.mdx

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Add Private Sources
3+
description: Add and manage private source documentation
4+
---
5+
6+
Add private sources to Context7 to make your internal documentation available to AI coding assistants. You can add sources from GitHub, GitLab, Bitbucket, other Git providers, Confluence, and OpenAPI specifications.
7+
8+
![Private Sources card showing a table of added sources and source type options](/images/dashboard/private-sources-card.png)
9+
10+
## Adding Private Sources
11+
12+
Follow these steps to add a private source:
13+
14+
1. Go to your teamspace's **Sources** tab
15+
2. **Click "Add another"** to open the source type selector
16+
3. **Select a source type**:
17+
- **GitHub** — connect your GitHub account and select a repository
18+
- **GitLab** — connect your GitLab account and select a project
19+
- **Bitbucket** — connect your Bitbucket account and select a repository
20+
- **Other Git** — add any Git repository by URL
21+
- **Confluence** — connect your Confluence workspace
22+
- **OpenAPI** — add an OpenAPI specification
23+
4. **Authorize** Context7 to access your source (if required)
24+
5. **Submit** for parsing
25+
26+
<Note>You must have a Pro or Enterprise plan to add private sources. Public sources can be added from the [Add Library](https://context7.com/add-library) page.</Note>
27+
28+
## Source Management
29+
30+
### Refreshing Documentation
31+
32+
Keep your private documentation up to date:
33+
34+
1. **Click the refresh icon** next to the source
35+
2. Context7 re-parses the source
36+
3. **You're only charged for changed content** — cached pages are free
37+
38+
**When to refresh**:
39+
40+
- After major documentation updates
41+
- After releasing new features
42+
- When you notice outdated information
43+
44+
<Tip>Refresh private sources only after significant documentation changes to minimize costs.</Tip>
45+
46+
### Removing Sources
47+
48+
To remove a private source:
49+
50+
1. **Click the trash icon** next to the source
51+
2. **Confirm deletion** in the modal
52+
3. Source documentation becomes unavailable immediately
53+
54+
<Warning>
55+
This action is permanent. The source will no longer be accessible via the API.
56+
</Warning>
57+
58+
## Permissions
59+
60+
Access to private source management is restricted by role. Only Owners and Admins can add, refresh, or remove private sources. Developers can view source documentation but cannot manage sources.
61+
62+
See [Teamspace Management](/howto/teamspace#roles) for the complete permissions table.
63+
64+
## Configuration
65+
66+
### Using `context7.json`
67+
68+
Add a `context7.json` file to your repository root for better control over parsing:
69+
70+
```json
71+
{
72+
"$schema": "https://context7.com/schema/context7.json",
73+
"projectTitle": "Your Project Name",
74+
"description": "Brief description of your project",
75+
"folders": ["docs", "guides"],
76+
"excludeFolders": ["tests", "dist", "node_modules"],
77+
"excludeFiles": ["CHANGELOG.md"],
78+
"rules": ["Always validate user input", "Use TypeScript strict mode"]
79+
}
80+
```
81+
82+
See the [Adding Libraries](/adding-libraries) page for complete configuration options.

docs/howto/teamspace.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Add team members, assign roles, and manage access to your Context7 dashboard fro
4242

4343
If you are the owner of the teamspace, you can rename or delete the teamspace under the overview tab.
4444

45-
![Teamspace management card](/images/dashboard/team-management-card.png)
45+
![Teamspace management card](/images/dashboard/teamspace-management.png)
4646

4747
<Warning>Deleting a teamspace is permanent. All members lose access immediately.</Warning>
4848

docs/howto/usage.mdx

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,35 @@ title: Monitor Usage
33
description: Monitor your Context7 API usage and track costs
44
---
55

6-
Track your Context7 usage with real-time metrics from the Overview tab.
6+
Track your Context7 usage with real-time metrics from the **Overview** tab on your teamspace dashboard.
77

8-
![Usage statistics card showing metrics and cost breakdown](/images/dashboard/usage-stats.png)
8+
![Usage statistics card showing requests, parsing tokens, seats, and cost breakdown](/images/dashboard/usage-stats.png)
99

1010
## Metrics Overview
1111

12-
Context7 tracks four key metrics to help you understand your usage patterns:
12+
The Overview tab displays four metrics:
1313

14-
### Search & Query Requests
14+
### Requests
1515

16-
The total number of API calls made to Context7:
17-
18-
- **Search Requests**: Library search queries
19-
- **Query Requests**: Documentation retrieval calls
20-
21-
### Query Tokens
22-
23-
The total number of tokens returned in API responses. This reflects how much documentation content you've retrieved.
24-
25-
<Tip>Search requests, Query requests, and Query tokens do not affect cost.</Tip>
16+
The total number of API calls made to Context7, shown against your plan's included quota. Requests within your quota are free; excess requests are billed based on your plan.
2617

2718
### Parsing Tokens
2819

29-
The total tokens processed when parsing private repository documentation (Pro and Enterprise only).
30-
31-
**How it works**:
20+
The total tokens processed when parsing private source documentation (Pro and Enterprise only).
3221

33-
- Charged when adding a new private repository
22+
- Charged when adding a new private source
3423
- Charged for changed content when refreshing
3524
- No charge for cached content when refreshing
3625

37-
**Cost**: $25 per 1M tokens
38-
39-
### Total Cost
40-
41-
Your monthly cost in USD (Pro and Enterprise only).
42-
43-
**Calculation**:
44-
45-
```
46-
Total Cost = Parsing Cost + Teamspace Cost
26+
### Seats
4727

48-
Parsing Cost = (Parsing Tokens / 1,000,000) × $25
49-
Teamspace Cost = Number of Members × $7
50-
```
28+
The number of members in your teamspace. Each seat is billed monthly based on your plan.
5129

52-
**Example**:
30+
### Cost
5331

54-
- Teamspace: 4 members
55-
- Parsing: 800K tokens this month
56-
- Cost: (800K / 1M × $25) + (4 × $7) = $20 + $28 = **$48**
32+
Your total monthly cost in USD, with a breakdown of each component: request overages, parsing tokens, and seats.
5733

58-
Hover over the Total Cost to see the detailed breakdown.
34+
See [Plans & Pricing](https://context7.com/plans) for current rates and included quotas.
5935

6036
## Reporting Periods
6137

248 KB
Loading
36.2 KB
Loading
399 KB
Loading

0 commit comments

Comments
 (0)