Skip to content

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

Update adding-projects.md

Enes Akar5520d0aa9401
diff --git a/docs/adding-projects.md b/docs/adding-projects.md
index 9374a8ca..c6833c75 100644
--- a/docs/adding-projects.md
+++ b/docs/adding-projects.md
@@ -38,42 +38,58 @@ Here's an example `context7.json` file with all available options:
> **💡 Pro Tip**: Including the `$schema` field enables autocomplete, validation, and helpful tooltips in modern code editors like VS Code, making it easier to create and maintain your configuration.
-#### Field Descriptions
+## Field Descriptions
-- **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM can not generate a name with high confidence.
+ - **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM
+ can not generate a name with high confidence.
-- **`description`** (string): Suggested description for your project in Context7. Only used when LLM can not generate a name with high confidence.
+ - **`description`** (string): Suggested description for your project in Context7. Only used when LLM can
+ not generate a name with high confidence.
-- **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will be used.
+ - **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will
+ be used.
-- **`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7 will scan the entire repository for relevant documentation files. Supports regex patterns and requires full paths.
+ - **`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7
+ will scan the entire repository for relevant documentation files. Note: Root-level markdown files are
+ always included regardless of this setting.
-- **`excludeFolders`** (array): Folder paths to exclude from documentation parsing. Useful for excluding source code directories, build folders, or other non-documentation content. Supports regex patterns and requires full paths.
+ - **`excludeFolders`** (array): Patterns to exclude folders and paths from documentation parsing.
+ Supports simple names, paths, and glob patterns (see Exclusion Patterns section below).
-- **`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other non-documentation content that might not be relevant for coding agents. Regex patterns are not supported.
+ - **`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include
+ the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other
+ non-documentation content.
-- **`rules`** (array): Best practices or important guidelines that coding agents should follow when using your library. These appear as recommendations in the documentation context provided to coding agents.
+ - **`rules`** (array): Best practices or important guidelines that coding agents should follow when
+ using your library. These appear as recommendations in the documentation context provided to coding
+ agents.
-- **`previousVersions`** (array): Information about previous versions of your library that should also be available in Context7.
- - **`tag`**: The Git tag or version identifier
- - **`title`**: Human-readable version name
-
+ - **`previousVersions`** (array): Information about previous versions of your library that should also
+ be available in Context7.
+ - **`tag`**: The Git tag or version identifier
+ - **`title`**: Human-readable version name
-### Exclusion Patterns:
-The `excludeFolders` parameter supports various pattern types for flexible exclusion:
+ ### Exclusion Patterns
-- **Simple folder names**: `"node_modules"` - Excludes any folder named "node_modules" anywhere in the tree
-- **Path patterns**: `"app-sdk/v2.3"` - Excludes specific paths and everything under them
-- **Glob patterns**: `"*.test"`, `"temp*"` - Excludes folders matching the pattern
-- **Globstar patterns**: `"**/dist"`, `"docs/**/internal"` - Advanced path matching
-- **Complex patterns**: `"src/**/*.test.js"` - Exclude test files in src directory
+ The `excludeFolders` parameter supports various pattern types for flexible exclusion:
-Examples:
-- `"node_modules"` - Excludes all node_modules folders
-- `"app-sdk/v2.3"` - Excludes app-sdk/v2.3 and all its contents
-- `"*.test"` - Excludes folders ending with .test
-- `"docs/**/internal"` - Excludes any "internal" folder under docs
+ - **Simple folder names**: `"node_modules"` - Excludes any folder named "node_modules" anywhere in the
+ tree
+ - **Root-specific patterns**: `"./xyz"` - Excludes folder only at repository root (e.g., excludes `/xyz`
+ but not `/dist/xyz`)
+ - **Path patterns**: `"app-sdk/v2.3"` - Excludes specific paths and everything under them
+ - **Glob patterns**: `"*.test"`, `"temp*"` - Excludes folders matching the pattern
+ - **Globstar patterns**: `"**/dist"`, `"docs/**/internal"` - Advanced path matching
+ - **Complex patterns**: `"src/**/*.test.js"` - Exclude test files in src directory
+
+ Examples:
+ - `"node_modules"` - Excludes all node_modules folders anywhere
+ - `"./build"` - Excludes build folder only at root (not `src/build`)
+ - `"app-sdk/v2.3"` - Excludes app-sdk/v2.3 path and all its contents
+ - `"*.test"` - Excludes folders ending with .test
+ - `"docs/**/internal"` - Excludes any "internal" folder under docs
+ - `"**/temp"` - Excludes any folder named "temp" anywhere
### Default Exclusions