agent-context 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dd25415ecb31136843810a6455fa0594d134b4fe8c926a8b43f75b18be232d2
-  data.tar.gz: bf2d14ca245188f5a878ae6761b5092d69c0c1fc80c90d3bccd5dc16a61459ec
+  metadata.gz: 52c1839c403ab5a9b54f0ea7604d792fd284eb19c789a5f9d2afe356e6c7d992
+  data.tar.gz: 1f20c9f320200d4f2e70b838ba1a478ff69831924df81ce891115e3abfc6896f
 SHA512:
-  metadata.gz: 5a8e4b97106b8eda55a54ff66a471c1cb272d987bb9359620a7722cd410471abaf7ac0c5b4ebc045410f5a4fc85ff687133a2eaec11ac53873f3fe2c2d7f8877
-  data.tar.gz: '002169fa66a2310b8e3c05eb7735165255136141cdb5daf6ad118daf69bb5c283e3ef6dc8ad3a8f39f4c37fa60cdc13f88d0d4a4fca713d85e3bb0652607b8a1'
+  metadata.gz: d942db85db0f5a98a0feaf136cd43ca270f3ce29db40f1f63a4df899c9394194fba691b588caf6191d2b653b064cc16d18362abbf66786d9e6f3b42f6f30503f
+  data.tar.gz: feb0ba1a782cb034dcabfb8fe50767f4ff490b7ede56fada3b34a7124a659b8ce76aa6e14efca0a2ebf6ec456ebaa8fd2fb2b64ad2d73fe65b5c115a3c95507f

data/bake/agent/context.rb

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2025, by Shopify Inc.
+# Copyright, 2025, by Samuel Williams.
 
 require_relative "../../lib/agent/context/helper"
 

data/context/{adding-context.mdc → adding-context.md}

@@ -1,7 +1,3 @@
----
-description: When creating or updating a gem's public interface.
-alwaysApply: false
----
 # Adding Context to Your Gem
 
 ## How to provide context in your gem
@@ -13,9 +9,9 @@ In your gem's root directory, create a `context/` folder:
 ```
 your-gem/
 ├── context/
-│   ├── getting-started.mdc
-│   ├── configuration.mdc
-│   └── troubleshooting.mdc
+│   ├── getting-started.md
+│   ├── configuration.md
+│   └── troubleshooting.md
 ├── lib/
 └── your-gem.gemspec
 ```
@@ -24,12 +20,12 @@ your-gem/
 
 Create files with helpful information. Common types include:
 
-- **getting-started.mdc** - Quick start guide
-- **configuration.mdc** - Configuration options and examples
-- **troubleshooting.mdc** - Common issues and solutions
-- **migration.mdc** - Migration guides between versions
-- **performance.mdc** - Performance tips and best practices
-- **security.mdc** - Security considerations
+- **getting-started.md** - Quick start guide
+- **configuration.md** - Configuration options and examples
+- **troubleshooting.md** - Common issues and solutions
+- **migration.md** - Migration guides between versions
+- **performance.md** - Performance tips and best practices
+- **security.md** - Security considerations
 
 ### 3. Document your context
 
@@ -45,13 +41,13 @@ bake agent:context:install --gem your-gem-name
 ```
 
 Available context files:
-- `getting-started.mdc` - Quick start guide
-- `configuration.mdc` - Configuration options
+- `getting-started.md` - Quick start guide
+- `configuration.md` - Configuration options
 ```
 
 ### 4. File format
 
-Context files can be in any format, but `.mdc` and `.md` are commonly used for documentation. The content should be:
+Context files can be in any format, but `.md` and `.md` are commonly used for documentation. The content should be:
 
 - **Practical** - Include real examples
 - **Focused** - One topic per file
@@ -98,9 +94,9 @@ In your gem's root directory, create a `context/` folder:
 ```
 your-gem/
 ├── context/
-│   ├── getting-started.mdc
-│   ├── configuration.mdc
-│   └── troubleshooting.mdc
+│   ├── getting-started.md
+│   ├── configuration.md
+│   └── troubleshooting.md
 ├── lib/
 └── your-gem.gemspec
 ```
@@ -109,12 +105,12 @@ your-gem/
 
 Create files with helpful information. Common types include:
 
-- **getting-started.mdc** - Quick start guide
-- **configuration.mdc** - Configuration options and examples
-- **troubleshooting.mdc** - Common issues and solutions
-- **migration.mdc** - Migration guides between versions
-- **performance.mdc** - Performance tips and best practices
-- **security.mdc** - Security considerations
+- **getting-started.md** - Quick start guide
+- **configuration.md** - Configuration options and examples
+- **troubleshooting.md** - Common issues and solutions
+- **migration.md** - Migration guides between versions
+- **performance.md** - Performance tips and best practices
+- **security.md** - Security considerations
 
 ### 3. Document your context
 
@@ -128,7 +124,7 @@ This gem provides additional context files that can be installed using `bake age
 
 ### 4. File format
 
-Context files can be in any format, but `.mdc` and `.md` are commonly used for documentation. The content should be:
+Context files can be in any format, but `.md` and `.md` are commonly used for documentation. The content should be:
 
 - **Practical** - Include real examples
 - **Focused** - One topic per file

data/context/{examples.mdc → examples.md}

@@ -1,8 +1,3 @@
----
-description: Practical examples of using agent-context.
-alwaysApply: false
----
-
 # Practical Examples
 
 ## Example 1: Installing context from a web framework
@@ -64,10 +59,10 @@ ls .context/
 bake agent:context:install --gem the-gem-you're-using
 
 # Read the getting started guide
-cat .context/the-gem-you're-using/getting-started.mdc
+cat .context/the-gem-you're-using/getting-started.md
 
 # Check performance tips
-cat .context/the-gem-you're-using/performance.mdc
+cat .context/the-gem-you're-using/performance.md
 ```
 
 ## Real-world scenario
@@ -79,10 +74,10 @@ You're building a Rails API and want to understand how to properly configure Pum
 bake agent:context:install --gem puma
 
 # Read the configuration guide
-cat .context/puma/configuration.mdc
+cat .context/puma/configuration.md
 
 # Check performance recommendations
-cat .context/puma/performance.mdc
+cat .context/puma/performance.md
 ```
 
 This gives you practical, gem-specific guidance that might not be in the main documentation.

data/context/{getting-started.mdc → getting-started.md}

@@ -1,8 +1,3 @@
----
-description: Getting started with agent-context.
-alwaysApply: false
----
-
 # Getting Started
 
 ## What is this?
@@ -41,10 +36,10 @@ For example:
 your-project/
 ├── .context/
 │   ├── async/
-│   │   ├── thread-safety.mdc
-│   │   └── performance.mdc
+│   │   ├── thread-safety.md
+│   │   └── performance.md
 │   └── rack/
-│       └── middleware.mdc
+│       └── middleware.md
 ```
 
 ## Why use this?

data/design.md

@@ -16,7 +16,7 @@ Context files are treated as a first-class part of a gem's public interface, alo
 
 ### 2. Machine-Readable, Human-Friendly
 
-Context files use `.mdc` (Markdown Context) format, which combines:
+Context files use `.md` (Markdown Context) format, which combines:
 - **Human readability**: Standard Markdown for easy authoring and reading.
 - **Machine structure**: YAML frontmatter for metadata and organization.
 - **Extensibility**: Can include code examples, diagrams, and structured data.
@@ -80,8 +80,8 @@ alwaysApply: false                  # Whether to always apply this context
 
 ### File Naming Conventions
 
-- **`.mdc` extension**: Indicates Markdown Context files.
-- **Descriptive names**: `thread-safety.mdc`, `performance.mdc`, `migration-guide.mdc`.
+- **`.md` extension**: Indicates Markdown Context files.
+- **Descriptive names**: `thread-safety.md`, `performance.md`, `migration-guide.md`.
 - **Fallback support**: Commands can find files with or without extensions.
 
 ## Installation Strategy
@@ -102,10 +102,10 @@ alwaysApply: false                  # Whether to always apply this context
 project/
 ├── .context/           # Private working directory
 │   ├── async/         # Context from async gem
-│   │   ├── thread-safety.mdc
-│   │   └── performance.mdc
+│   │   ├── thread-safety.md
+│   │   └── performance.md
 │   └── rails/         # Context from rails gem
-│       └── configuration.mdc
+│       └── configuration.md
 ```
 
 ## Use Cases and Workflows
@@ -113,7 +113,7 @@ project/
 ### For Gem Authors
 
 1. **Create Context Directory**: Add `context/` to gem root.
-2. **Write Context Files**: Create `.mdc` files with documentation, examples, guides.
+2. **Write Context Files**: Create `.md` files with documentation, examples, guides.
 3. **Version and Distribute**: Context files are included in gem releases.
 
 ### For Developers
@@ -132,7 +132,7 @@ project/
 
 ### Potential Enhancements
 
-- **Context Validation**: Validate `.mdc` file structure and content.
+- **Context Validation**: Validate `.md` file structure and content.
 - **Context Indexing**: Create searchable index of installed context.
 - **Context Updates**: Mechanism to update context when gems are updated.
 - **Context Dependencies**: Allow context files to reference other context files.

data/lib/agent/context/helper.rb

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2025, by Shopify Inc.
+# Copyright, 2025, by Samuel Williams.
 
 require "rubygems"
 require "fileutils"
@@ -71,7 +72,7 @@ module Agent
 				# Try to find the file with or without extension
 				possible_paths = [
 						File.join(gem[:path], file_name),
-						File.join(gem[:path], "#{file_name}.mdc"),
+						File.join(gem[:path], "#{file_name}.md"),
 						File.join(gem[:path], "#{file_name}.md")
 					]
 					

data/lib/agent/context/version.rb

@@ -2,9 +2,10 @@
 
 # Released under the MIT License.
 # Copyright, 2025, by Shopify Inc.
+# Copyright, 2025, by Samuel Williams.
 
 module Agent
 	module Context
-		VERSION = "0.0.1"
+		VERSION = "0.0.2"
 	end
 end 

data/license.md

@@ -1,6 +1,7 @@
 # MIT License
 
 Copyright, 2025, by Shopify Inc.  
+Copyright, 2025, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -68,13 +68,13 @@ To provide context files in your gem, create a `context/` directory in your gem'
 
     your-gem/
     ├── context/
-    │   ├── thread-safety.mdc
-    │   ├── performance.mdc
-    │   └── migration-guide.mdc
+    │   ├── thread-safety.md
+    │   ├── performance.md
+    │   └── migration-guide.md
     ├── lib/
     └── your-gem.gemspec
 
-Context files can be in any format, but `.mdc` and `.md` files are commonly used for documentation.
+Context files can be in any format, but `.md` and `.md` files are commonly used for documentation.
 
 ## See Also
 

metadata

@@ -1,9 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: agent-context
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
+- Samuel Williams
 - Shopify Inc.
 bindir: bin
 cert_chain:
@@ -57,10 +58,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bake/agent/context.rb
-- context/adding-context.mdc
-- context/examples.mdc
-- context/getting-started.mdc
-- context/markdown-context.mdc
+- context/adding-context.md
+- context/examples.md
+- context/getting-started.md
 - design.md
 - lib/agent/context.rb
 - lib/agent/context/helper.rb

data/context/markdown-context.mdc

@@ -1,91 +0,0 @@
----
-globs: *.mdc
-alwaysApply: false
----
-# Creating `.mdc` (Markdown Context) Files
-
-## What is an `.mdc` file?
-
-An `.mdc` file is a Markdown file with optional YAML frontmatter, used to provide context, documentation, or metadata for Ruby gems. These files are intended to be machine- and human-readable, and are used by tools like `agent-context` to expose useful information to users and agents.
-
-## Structure
-
-### 1. YAML Frontmatter (Optional but Recommended)
-
-Start your `.mdc` file with a YAML frontmatter block:
-
-```yaml
----
-description: Short summary of the file's purpose
-globs: "test/**/*.rb,lib/**/*.rb"   # Optional: comma-separated file patterns
-alwaysApply: false                  # Optional: should this context always be applied?
----
-```
-
-**Fields:**
-- `description` (required): Short, human-readable summary.
-- `globs` (optional): Comma-separated string of file patterns this context applies to.
-- `alwaysApply` (optional): Whether to always apply this context (default: false).
-
-### 2. Markdown Content
-
-After the frontmatter, write your documentation in standard Markdown:
-
-~~~markdown
-# Title
-
-## Section
-
-- Bullet points
-- More details
-
-```ruby
-# Code examples
-```
-~~~
-
-## Best Practices
-
-- **Start with a clear description** in the YAML frontmatter.
-- **Use headings** (`#`, `##`) to organize content.
-- **Keep each file focused** on a single topic.
-- **Include code examples** where relevant.
-- **Use lists** for options, steps, or best practices.
-- **Be concise and actionable.**
-- **Use tags and globs** to help agents and tools categorize and apply context.
-
-## Example `.mdc` File
-
-~~~markdown
----
-description: How to configure the gem for production use.
-globs: config/my_gem.rb
-alwaysApply: false
----
-
-# Production Configuration
-
-To configure my_gem for production:
-
-1. Set the environment variable:
-   ```sh
-   export GEM_ENV=production
-   ```
-2. Update your config file:
-   ```ruby
-   MyGem.configure do |config|
-     config.mode = :production
-   end
-   ```
-3. Restart your application.
-~~~
-
-## When to Use `.mdc` Files
-
-- To provide documentation, guides, or metadata for your gem.
-- To expose best practices, migration guides, or troubleshooting tips.
-- To help AI agents and tools discover and apply context automatically.
-
-## Further Reading
-- [YAML Frontmatter Spec](https://jekyllrb.com/docs/front-matter/)
-- [Markdown Guide](https://www.markdownguide.org/)