Skip to content

Commit 5520d0a

Browse files
authored
Update adding-projects.md
1 parent 0b19c43 commit 5520d0a

File tree

1 file changed

+40
-24
lines changed

1 file changed

+40
-24
lines changed

‎docs/adding-projects.md‎

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -38,42 +38,58 @@ Here's an example `context7.json` file with all available options:
3838

3939
> **💡 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.
4040
41-
#### Field Descriptions
41+
## Field Descriptions
4242

43-
- **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM can not generate a name with high confidence.
43+
- **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM
44+
can not generate a name with high confidence.
4445

45-
- **`description`** (string): Suggested description for your project in Context7. Only used when LLM can not generate a name with high confidence.
46+
- **`description`** (string): Suggested description for your project in Context7. Only used when LLM can
47+
not generate a name with high confidence.
4648

47-
- **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will be used.
49+
- **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will
50+
be used.
4851

49-
- **`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.
52+
- **`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7
53+
will scan the entire repository for relevant documentation files. Note: Root-level markdown files are
54+
always included regardless of this setting.
5055

51-
- **`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.
56+
- **`excludeFolders`** (array): Patterns to exclude folders and paths from documentation parsing.
57+
Supports simple names, paths, and glob patterns (see Exclusion Patterns section below).
5258

53-
- **`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.
59+
- **`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include
60+
the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other
61+
non-documentation content.
5462

55-
- **`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.
63+
- **`rules`** (array): Best practices or important guidelines that coding agents should follow when
64+
using your library. These appear as recommendations in the documentation context provided to coding
65+
agents.
5666

57-
- **`previousVersions`** (array): Information about previous versions of your library that should also be available in Context7.
58-
- **`tag`**: The Git tag or version identifier
59-
- **`title`**: Human-readable version name
60-
67+
- **`previousVersions`** (array): Information about previous versions of your library that should also
68+
be available in Context7.
69+
- **`tag`**: The Git tag or version identifier
70+
- **`title`**: Human-readable version name
6171

62-
### Exclusion Patterns:
6372

64-
The `excludeFolders` parameter supports various pattern types for flexible exclusion:
73+
### Exclusion Patterns
6574

66-
- **Simple folder names**: `"node_modules"` - Excludes any folder named "node_modules" anywhere in the tree
67-
- **Path patterns**: `"app-sdk/v2.3"` - Excludes specific paths and everything under them
68-
- **Glob patterns**: `"*.test"`, `"temp*"` - Excludes folders matching the pattern
69-
- **Globstar patterns**: `"**/dist"`, `"docs/**/internal"` - Advanced path matching
70-
- **Complex patterns**: `"src/**/*.test.js"` - Exclude test files in src directory
75+
The `excludeFolders` parameter supports various pattern types for flexible exclusion:
7176

72-
Examples:
73-
- `"node_modules"` - Excludes all node_modules folders
74-
- `"app-sdk/v2.3"` - Excludes app-sdk/v2.3 and all its contents
75-
- `"*.test"` - Excludes folders ending with .test
76-
- `"docs/**/internal"` - Excludes any "internal" folder under docs
77+
- **Simple folder names**: `"node_modules"` - Excludes any folder named "node_modules" anywhere in the
78+
tree
79+
- **Root-specific patterns**: `"./xyz"` - Excludes folder only at repository root (e.g., excludes `/xyz`
80+
but not `/dist/xyz`)
81+
- **Path patterns**: `"app-sdk/v2.3"` - Excludes specific paths and everything under them
82+
- **Glob patterns**: `"*.test"`, `"temp*"` - Excludes folders matching the pattern
83+
- **Globstar patterns**: `"**/dist"`, `"docs/**/internal"` - Advanced path matching
84+
- **Complex patterns**: `"src/**/*.test.js"` - Exclude test files in src directory
85+
86+
Examples:
87+
- `"node_modules"` - Excludes all node_modules folders anywhere
88+
- `"./build"` - Excludes build folder only at root (not `src/build`)
89+
- `"app-sdk/v2.3"` - Excludes app-sdk/v2.3 path and all its contents
90+
- `"*.test"` - Excludes folders ending with .test
91+
- `"docs/**/internal"` - Excludes any "internal" folder under docs
92+
- `"**/temp"` - Excludes any folder named "temp" anywhere
7793

7894
### Default Exclusions
7995

0 commit comments

Comments
 (0)