Skip to content

Commit 1dd204d

Browse files
committed
feat: Add tooling recommendations and future directions sections
1 parent a760aac commit 1dd204d

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

CODEBASE-CONTEXT.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -312,26 +312,10 @@ documentation:
312312
- Regularly review and update the `.contextdocs` file to ensure all referenced documentation remains relevant and up-to-date.
313313
- Consider implementing caching mechanisms for external documentation to improve performance and reduce network requests.
314314

315-
## 9. Tooling Recommendations
316-
317-
Developers are encouraged to create:
318-
319-
1. Linters and validators for context files
320-
2. IDE plugins for context file creation and editing
321-
3. AI model integrations for parsing and utilizing context
322-
4. Tools for aggregating and presenting project-wide context
323-
324-
## 10. Future Directions
325-
326-
1. Standardized query language for context interrogation
327-
2. Integration with existing documentation systems
328-
3. Dynamic context generation through code analysis
329-
4. Potential support for explicit context overriding
330-
331-
## 11. Conclusion
315+
## 9. Conclusion
332316

333317
The AI Context Convention provides a flexible, standardized approach to enriching codebases with contextual information for AI models. By adopting this convention, development teams can enhance AI-assisted workflows, improving code quality and development efficiency across projects of any scale or complexity. The addition of the `.contextdocs` file further enriches the available context by allowing the incorporation of external documentation, ensuring that AI models have access to comprehensive information about the project and its dependencies.
334318

335-
## 12. TypeScript Linter Implementation
319+
## 10. TypeScript Linter Implementation
336320

337321
For details on the TypeScript implementation of the linter for validating AI Context Convention files, please refer to the [TypeScript Linter README](linters/typescript/README.md).

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,22 @@ The Codebase Context Specification is currently in a preview state. We're active
2222

2323
For the full specification, please refer to [CODEBASE-CONTEXT.md](CODEBASE-CONTEXT.md).
2424

25+
## Tooling Recommendations
26+
27+
Developers are encouraged to create:
28+
29+
1. Linters and validators for context files
30+
2. IDE plugins for context file creation and editing
31+
3. AI model integrations for parsing and utilizing context
32+
4. Tools for aggregating and presenting project-wide context
33+
34+
## Future Directions
35+
36+
1. Standardized query language for context interrogation
37+
2. Integration with existing documentation systems
38+
3. Dynamic context generation through code analysis
39+
4. Potential support for explicit context overriding
40+
2541
## Contribution / RFC Process
2642

2743
We welcome contributions and feedback from the community to help shape the final specification. Here's how you can get involved:

0 commit comments

Comments
 (0)