docs: add links

Author: killerapp

.context.md

@@ -111,4 +111,21 @@ Each release goes through the following process:
 5. Deployment to staging (documentation update)
 6. Final approval and deployment to production (npm package release)
 
-For more detailed information, please refer to the individual documents and subdirectories.
+For more detailed information, please refer to the individual documents and subdirectories.
+
+## Links for promotion / highlighting
+
+The linter and the main README need to have good cross-linking. The NPM readme and the main readme are missing some things. There's been a new youtube video / press coverage of the idea. I want to give you those links and have you incorporate them in. Also the npm bullet at the top of the main readme isn't tracking the version number in npm properly.
+
+Actual Specification:
+https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODEBASE-CONTEXT.md
+
+GitHub Repo
+https://github.com/Agentic-Insights/codebase-context-spec
+
+SubStack article by the author (Vaskin):
+https://agenticinsights.substack.com/p/codebase-context-specification-rfc
+
+NPM package for linter:
+https://www.npmjs.com/package/codebase-context-lint
+

README.md

@@ -1,13 +1,22 @@
 # Codebase Context Specification (CCS) v 1.0.0-RFC
 
-[![npm version](https://badge.fury.io/js/codebase-context-lint.svg)](https://www.npmjs.com/package/codebase-context-lint)
+[![npm version](https://img.shields.io/npm/v/codebase-context-lint.svg)](https://www.npmjs.com/package/codebase-context-lint)
 
 ![Codebase Context Image](./img/codebase-context.png "Codebase Context Specification")
 
 ## Introduction
 
 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.
 
+## Quick Links
+
+- [Full Specification (CODEBASE-CONTEXT.md)](./CODEBASE-CONTEXT.md)
+- [GitHub Repository](https://github.com/Agentic-Insights/codebase-context-spec)
+- [NPM Package (codebase-context-lint)](https://www.npmjs.com/package/codebase-context-lint)
+- [SubStack Article by Vaskin](https://agenticinsights.substack.com/p/codebase-context-specification-rfc)
+- [Context File Example (.context.md)](.context.md)
+- [AI Assistant Prompt (CODING-ASSISTANT-PROMPT.md)](CODING-ASSISTANT-PROMPT.md)
+
 ## Codebase Context: A New Convention
 
 The Codebase Context Specification introduces 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 (`.context.md`, `.context.yaml`, `.context.json`) provide a standardized way to capture and communicate the context of your codebase.
@@ -35,11 +44,23 @@ The Codebase Context Specification is currently in a preview state. We're active
 
 ## Specification
 
-For the full specification, please refer to [CODEBASE-CONTEXT.md](CODEBASE-CONTEXT.md).
+For the full specification, please refer to [CODEBASE-CONTEXT.md](./CODEBASE-CONTEXT.md).
+
+## Linter
+
+We provide a linter to help validate your context files according to the specification. You can find the NPM package here: [codebase-context-lint](https://www.npmjs.com/package/codebase-context-lint).
+
+To install the linter:
+
+```bash
+npm install -g codebase-context-lint
+```
+
+For more information on using the linter, please refer to the [linter's README](./linters/typescript/README.md).
 
 ## Using with AI Assistants
 
-The [CODING-ASSISTANT-PROMPT.md](CODING-ASSISTANT-PROMPT.md) file provides guidelines for AI assistants to understand and use the Codebase Context Specification. This allows for immediate adoption of the specification without requiring specific tooling integration.
+The [CODING-ASSISTANT-PROMPT.md](./CODING-ASSISTANT-PROMPT.md) file provides guidelines for AI assistants to understand and use the Codebase Context Specification. This allows for immediate adoption of the specification without requiring specific tooling integration.
 
 To use the Codebase Context Specification with an AI assistant:
 
@@ -54,12 +75,11 @@ Note that while this approach allows for immediate use of the specification, som
 Developers are encouraged to create:
 
 - Memory systems using git branches as storage
-- Linters and validators for context files
 - IDE plugins for context file creation and editing
 - AI model integrations for parsing and utilizing context
 - Tools for aggregating and presenting project-wide context
 - Agents that can help create context in codebases that are blank
-- Codebase summariziers, submodule summarizers
+- Codebase summarizers, submodule summarizers
 - Memory systems that take advantage of the context
 - Continuous TODO monitors that can re-try implementations / solutions
 
@@ -77,16 +97,14 @@ We welcome contributions and feedback from the community to help shape the final
 1. **Review the Specification**: Start by thoroughly reading the current specification in CODEBASE-CONTEXT.md.
 2. **Open an Issue**: For suggestions, questions, or concerns, open an issue in this repository.
 3. **Submit a Pull Request**: For proposed changes or additions, submit a pull request with a clear description of your modifications.
-4. [**Join the Discussion**(https://github.com/Agentic-Insights/codebase-context-spec/discussions)]: Participate in open discussions and provide your insights on existing issues and pull requests.
+4. [**Join the Discussion**](https://github.com/Agentic-Insights/codebase-context-spec/discussions): Participate in open discussions and provide your insights on existing issues and pull requests.
 
 All contributions will be reviewed and discussed openly. Significant changes may go through an RFC (Request for Comments) process to ensure thorough consideration and community input.
 
 ## Version History
 
 - 1.0-preview: Initial preview release of the Codebase Context Specification
 
-## Main Links
+## Learn More
 
-- [Full Specification (CODEBASE-CONTEXT.md)](CODEBASE-CONTEXT.md)
-- [Context File Example (.context.md)](.context.md)
-- [AI Assistant Prompt (CODING-ASSISTANT-PROMPT.md)](CODING-ASSISTANT-PROMPT.md)
+For a deeper dive into the Codebase Context Specification, check out this [SubStack article by Vaskin](https://agenticinsights.substack.com/p/codebase-context-specification-rfc), the author of the specification.

linters/typescript/README.md

@@ -33,6 +33,8 @@ This convention allows developers to:
 
 By adopting this convention, teams can ensure that both human developers and AI assistants have access to crucial contextual information, leading to better code understanding, more accurate suggestions, and improved overall development efficiency.
 
+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).
+
 ## 📦 Installation
 
 You can install the linter globally using npm:
@@ -61,16 +63,14 @@ Replace `<directory_to_lint>` with the path to the directory containing your Cod
 
 ## 🤖 Using with AI Assistants
 
-While this linter provides automated validation of CCS files, you can also use the Codebase Context Specification with AI assistants without any specific tooling. The [CODING-ASSISTANT-PROMPT.md](https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODING-ASSISTANT-PROMPT.md) file in the root directory provides guidelines for AI assistants to understand and use the Codebase Context Specification.
+While this linter provides automated validation of CCS files, you can also use the Codebase Context Specification with AI assistants without any specific tooling. The [CODING-ASSISTANT-PROMPT.md](https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODING-ASSISTANT-PROMPT.md) file in the main repository provides guidelines for AI assistants to understand and use the Codebase Context Specification.
 
 To use the Codebase Context Specification with an AI assistant:
 
 1. Include the content of CODING-ASSISTANT-PROMPT.md in your prompt to the AI assistant.
 2. Ask the AI to analyze your project's context files based on these guidelines.
 3. The AI will be able to provide more accurate and context-aware responses by following the instructions in the prompt.
 
-[A UI element graphic would be inserted here, demonstrating how the Codebase Context Specification could be integrated into development environments]
-
 Note that while this approach allows for immediate use of the specification, some features like .contextignore should eventually be applied by tooling (such as this linter) for more robust implementation.
 
 ## 🛠️ Development
@@ -104,6 +104,17 @@ To contribute to this project:
 7. Push to the branch (`git push origin feature/AmazingFeature`)
 8. Open a Pull Request
 
-## 📄 License
+## � Learn More
+
+For a deeper dive into the Codebase Context Specification, check out this [SubStack article by Vaskin](https://agenticinsights.substack.com/p/codebase-context-specification-rfc), the author of the specification.
+
+## �📄 License
+
+This project is licensed under the MIT License.
+
+## 🔗 Related Links
 
-This project is licensed under the MIT License.
+- [Codebase Context Specification Repository](https://github.com/Agentic-Insights/codebase-context-spec)
+- [Full Specification (CODEBASE-CONTEXT.md)](https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODEBASE-CONTEXT.md)
+- [NPM Package (codebase-context-lint)](https://www.npmjs.com/package/codebase-context-lint)
+- [AI Assistant Prompt (CODING-ASSISTANT-PROMPT.md)](https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODING-ASSISTANT-PROMPT.md)