You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,19 @@
8
8
9
9
Welcome to the [Codebase Context Specification (CCS)](./CODEBASE-CONTEXT.md) repository! This project establishes a standardized method for embedding rich contextual information within codebases to enhance understanding for both AI and human developers. By providing a clear and consistent way to communicate project structure, conventions, and key concepts, we significantly improve code comprehension and facilitate more effective collaboration between humans and AI in software development.
10
10
11
+
## Codebase Context Editor
12
+
13
+
To help you get started with creating context files for your project, we've developed the Codebase Context Editor. This tool simplifies the process of generating .context.md, .contextdocs.md, and .contextignore files that adhere to the Codebase Context Specification.
14
+
15
+
[**Get Started with the Codebase Context Editor**](https://agentic-insights.github.io/codebase-context-spec/)
16
+
17
+
The Codebase Context Editor provides an intuitive interface for:
18
+
- Creating and editing context files
19
+
- Viewing and copying AI prompts for context generation
20
+
- Validating your context files against the specification
21
+
22
+
Whether you're new to the Codebase Context Specification or an experienced user, the editor can significantly streamline your workflow.
Copy file name to clipboardExpand all lines: linters/typescript/README.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,19 @@
21
21
22
22
This is a CLI linter for validating Codebase Context Specification (CCS) files, including `.context.md`, `.context.yaml`, `.context.json`, `.contextdocs.md`, and `.contextignore` files. The Codebase Context Specification is a convention for documenting your code to enhance understanding for both AI and human developers.
23
23
24
+
## Codebase Context Editor
25
+
26
+
To help you get started with creating context files for your project, we've developed the Codebase Context Editor. This tool simplifies the process of generating .context.md, .contextdocs.md, and .contextignore files that adhere to the Codebase Context Specification.
27
+
28
+
[**Get Started with the Codebase Context Editor**](https://agentic-insights.github.io/codebase-context-spec/)
29
+
30
+
The Codebase Context Editor provides an intuitive interface for:
31
+
- Creating and editing context files
32
+
- Viewing and copying AI prompts for context generation
33
+
- Validating your context files against the specification
34
+
35
+
Whether you're new to the Codebase Context Specification or an experienced user, the editor can significantly streamline your workflow.
36
+
24
37
## 📚 What is Codebase Context?
25
38
26
39
Codebase Context is a convention similar to `.env` and `.editorconfig` systems, but focused on documenting your code for both AI and humans. Just as `.env` files manage environment variables and `.editorconfig` ensures consistent coding styles, CCS files provide a standardized way to capture and communicate the context of your codebase.
@@ -35,7 +48,7 @@ By adopting this convention, teams can ensure that both human developers and AI
35
48
36
49
For more detailed information about the Codebase Context Specification, please refer to the [main repository](https://github.com/Agentic-Insights/codebase-context-spec) and the [full specification](https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODEBASE-CONTEXT.md).
37
50
38
-
## � Supported Node.js Versions
51
+
## Supported Node.js Versions
39
52
40
53
This linter supports the following Node.js versions:
0 commit comments