wehub-resource-sync
43 lines
1.6 KiB
Plaintext
43 lines
1.6 KiB
Plaintext
---
|
|
title: Manage Rules
|
|
description: Prepend custom guidelines to the documentation your teamspace retrieves
|
|
---
|
|
|
|
Rules are custom instructions that are automatically prepended to the documentation context whenever your teamspace retrieves library docs. Use them to set coding standards, define architectural patterns, or specify framework preferences so every result follows your team's conventions.
|
|
|
|
Manage them from the [rules tab](https://context7.com/dashboard?tab=rules) of your dashboard.
|
|
|
|
<Note>Teamspace Rules are a Pro and Enterprise feature. Only owners and admins can add, edit, or delete rules; developers have read-only access.</Note>
|
|
|
|
## Rule Scopes
|
|
|
|
Each rule applies at one of two scopes:
|
|
|
|
- **Global Rules** — apply to every library your teamspace accesses.
|
|
- **Library-Specific Rules** — apply only when retrieving docs for a particular library.
|
|
|
|
## Examples
|
|
|
|
- "Always use TypeScript strict mode"
|
|
- "Prefer server components in Next.js"
|
|
- "Use the App Router, not the Pages Router"
|
|
|
|
## Adding a Rule
|
|
|
|
<Steps>
|
|
<Step title="Open the rules tab">
|
|
Open the [rules tab](https://context7.com/dashboard?tab=rules) and click **Add Rule...**.
|
|
</Step>
|
|
<Step title="Choose the scope">
|
|
Pick **Global** or a specific **Library**.
|
|
</Step>
|
|
<Step title="Enter the rule text">
|
|
Write the instruction you want prepended to retrieved documentation.
|
|
</Step>
|
|
<Step title="Save">
|
|
Save the rule. It takes effect on the next documentation request made with the teamspace's API keys.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Existing rules are grouped by scope in the list. Select **Global Rules** or any library entry to edit or remove its rules.
|