wehub-resource-sync
98 lines
3.4 KiB
Plaintext
98 lines
3.4 KiB
Plaintext
---
|
|
title: Add Private Sources
|
|
description: Add and manage private source documentation
|
|
---
|
|
|
|
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.
|
|
|
|
|
|
|
|
## Adding Private Sources
|
|
|
|
<Steps>
|
|
<Step title="Open the Sources tab">
|
|
Go to your teamspace's **Sources** tab.
|
|
</Step>
|
|
<Step title="Add a source">
|
|
Click **Add another** to open the source type selector.
|
|
</Step>
|
|
<Step title="Select a source type">
|
|
- **GitHub** — connect your GitHub account and select a repository
|
|
- **GitLab** — connect your GitLab account and select a project
|
|
- **Bitbucket** — connect your Bitbucket account and select a repository
|
|
- **Other Git** — add any Git repository by URL
|
|
- **Confluence** — connect your Confluence workspace
|
|
- **OpenAPI** — add an OpenAPI specification
|
|
</Step>
|
|
<Step title="Authorize access">
|
|
Authorize Context7 to access your source (if required).
|
|
</Step>
|
|
<Step title="Configure LLM analysis (optional)">
|
|
For repositories with little or no written documentation, check **Generate docs** to have Context7 generate documentation from the source code. Also available as the `generateDocs` flag in the [API](/api-guide).
|
|
</Step>
|
|
<Step title="Submit for parsing">
|
|
Submit the source for parsing.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<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>
|
|
|
|
## Source Management
|
|
|
|
### Refreshing Documentation
|
|
|
|
Keep your private documentation up to date:
|
|
|
|
1. **Click the refresh icon** next to the source
|
|
2. Context7 re-parses the source
|
|
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 sources only after significant documentation changes to minimize costs.</Tip>
|
|
|
|
### Removing Sources
|
|
|
|
<Steps>
|
|
<Step title="Delete the source">
|
|
Click the trash icon next to the source.
|
|
</Step>
|
|
<Step title="Confirm deletion">
|
|
Confirm in the modal. The source documentation becomes unavailable immediately.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Warning>
|
|
This action is permanent. The source will no longer be accessible via the API.
|
|
</Warning>
|
|
|
|
## Permissions
|
|
|
|
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.
|
|
|
|
See [Teamspace Management](/howto/teamspace#roles) for the complete permissions table.
|
|
|
|
## 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 [Library Owners](/library-owners) page for complete configuration options.
|