Skip to content

Commit 7f06d06

Browse files
committed
docs: add link to editor from published READMEs
1 parent d0132cd commit 7f06d06

File tree

3 files changed

+39
-10
lines changed

3 files changed

+39
-10
lines changed

.context.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
22
module-name: Codebase Context Specification
3-
version: 1.0.0
3+
version: 1.4.0
44
description: A specification for providing explicit context information about a codebase
55
related-modules:
66
- TypeScript Linter: ./linters/typescript
77
- Codebase Context Editor: ./examples/context-editor
88
technologies:
99
- Markdown
10-
- YAML
11-
- JSON
10+
- TypeScript
11+
- React
12+
- GitHub Actions
13+
- GitHub Pages
1214
conventions:
1315
- Follow Markdown best practices
1416
- Use YAML for structured data
@@ -22,15 +24,15 @@ diagrams:
2224
architecture:
2325
style: Documentation-driven
2426
components:
25-
- Specification document
26-
- Linters
27-
- context editor
27+
- Specification document, for use with multipe AI Agents
28+
- TypeScript Linter for tooling, VSCode extensions
29+
- Context editor for ronboarding
2830
data-flow:
2931
- Codebase -> .context.md files -> Linters -> Validation results
3032
development:
3133
setup-steps:
32-
- Clone the repository
33-
- Review the specification documents
34+
- Clone the repository that contains the linter
35+
- Review the specification document
3436
- Install linter dependencies
3537
build-command: npm run build
3638
test-command: npm test
@@ -39,8 +41,9 @@ business-requirements:
3941
- Provide a standardized format for codebase context
4042
- Enable AI-assisted development with explicit context
4143
- Support multiple programming languages and frameworks
42-
target-audience: Developers and AI assistants
44+
target-audience: Developers using cutting edge AI tools, early adopters
4345
success-metrics:
46+
- Coding agents adopting the CCS
4447
- Adoption rate among developers
4548
- Improved AI-assisted development accuracy
4649
quality-assurance:

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@
88

99
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.
1010

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.
23+
1124
## Quick Links
1225

1326
- [Full Specification (CODEBASE-CONTEXT.md)](./CODEBASE-CONTEXT.md)

linters/typescript/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@
2121

2222
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.
2323

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+
2437
## 📚 What is Codebase Context?
2538

2639
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
3548

3649
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).
3750

38-
## Supported Node.js Versions
51+
## Supported Node.js Versions
3952

4053
This linter supports the following Node.js versions:
4154

0 commit comments

Comments
 (0)