@@ -52,52 +52,38 @@ Use the following instruction to create a context file with detailed description
5252> help it understand the document structure.
5353
5454` ` `
55- Your goal is to create a `context.yaml` configuration that :
56-
57- 1. Organizes source code into logical, cohesive documents
58- 2. Provides detailed descriptions that explain each component's purpose and relationships
59- 3. Uses appropriate source types and filtering to capture relevant code
60- 4. Creates a structure that makes navigation and understanding intuitive
61-
62- # # Configuration Structure
63-
64- Start by analyzing the codebase to identify major functional areas. For each area, create a document with :
65-
66- 1. A clear, descriptive title that indicates the document's focus
67- 2. A detailed description explaining what functionality this area provides
68- 3. Sources that target the relevant files with appropriate filtering
69- 4. For each source, a comprehensive description of what those specific files contribute
70-
71- # # Provide the following information:
72-
73- Please create a configuration that :
74-
75- 1. Organizes the code by [functional areas/module types/etc.]
76- 2. Provides detailed descriptions explaining [what aspects you want explained]
77- 3. Uses [specific source types if relevant]
78- 4. Includes explanatory content using the text source type where helpful
79-
80- # # Best Practices
81-
82- When creating configurations :
83-
84- 1. **Use meaningful groupings** : Group related files together based on functionality rather than just directory
85- structure
86- 2. **Provide context in descriptions** : Explain not just what components do, but how they relate to the larger system
87- 3. **Use filtering effectively** : Apply path, pattern, and content filters to include only relevant files
88- 4. **Include architectural overviews** : Use text sources to provide high-level explanations where appropriate
89- 5. **Leverage tree visualizations** : For complex projects, include tree sources to visualize structure
90- 6. **Add directory context** : When using tree sources, add explanations via the dirContext property
91-
92- # # Using Advanced Features
93-
94- Consider using these advanced features for more comprehensive configurations :
95-
96- 1. **Modifier configurations** : Use php-content-filter or sanitizer modifiers to focus on relevant code parts
97- 2. **Combined sources** : Mix different source types (file, text, tree) in a document for richer context
98- 3. **Nested documents** : Create hierarchical document structures with overview and detail documents
99- 4. **Tag-based organization** : Use tags to create cross-cutting views of the codebase
100- 5. **GitDiff sources** : For evolving codebases, capture recent changes for focused documentation
55+ Your goal is to create a `context.yaml` file, using provided JSON schema for context generator.
56+ Always use YAML syntax.
57+
58+ Provide multiple configs. Split documents into small logical config files. Small configs is better that one big config.
59+
60+ **Rules**
61+ 1. **Organizes Code**
62+ - Split your source code into clear, logical documents based on its functions or modules.
63+ - Group related files together based on what they do, not just their folder structure.
64+ 2. **Detailed Descriptions**
65+ - Write a title and a short, clear description for each document.
66+ - Explain the purpose of each component and how they connect to the rest of the project.
67+ 3. **Relevant Sources and Filtering**
68+ - Use the right source types (file, text, tree, etc.) to capture the needed code.
69+ - Apply filters (by path, pattern, or content) to only include the important files.
70+ - Do not try to use `contains` filter. Only by file path.
71+ 4. **Output Paths**
72+ - Make sure output paths start with the content/context type, like `project/` or `feature/`.
73+ 5. **Content Limit**
74+ - Ensure that each document does not exceed 50,000 characters.
75+
76+ **Extra Tips:**
77+ - **Meaningful Groupings:** Focus on functionality. Group files that work together.
78+ - More small documents is better than one big document.
79+ - **Use Visuals:** For bigger projects, include tree views or mermaid diagrams with extra notes.
80+ - Do not provide default values for properties
81+ - Do not use quotes if it unnecessary
82+ - Do not use arrays in format `[...]`
83+ - Advanced Features :
84+ - Mix different source types for richer details.
85+ - Consider nested documents or tag-based views for more complex projects.
86+ - Use GitDiff sources if you need to show recent changes.
10187` ` `
10288
10389### Step 3: Explore Configuration and Entry Points
0 commit comments