agent-context 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e41e74cc802c2fdee00fb17ff69663982e4a336f8b4ec40489220baab76f625c
-  data.tar.gz: b321db5c2fe9c7b463336081d404dc50a16511aae9405a26b2dd384ac253315f
+  metadata.gz: 7dcf6ef1ced870cf21a982f53ef4d270621f9b215f2f21084b0f7aff9c71655c
+  data.tar.gz: 7ecbef44d024fa43a2dca67bdb2adc3765bb008fa0b36f33a1fd8bef7319286a
 SHA512:
-  metadata.gz: daf3b9bc9cb6a8de27f5d9dfa181661b9dff877b9b305938cc37b2d82b222bd70411557c9b791cdb35f557ba75e179b757328f841db0b7b51b051442119ae8e5
-  data.tar.gz: d41ed3d9ffe2f231a50002ee1d6583bef5fe4b17aa055025daf06b056aed98e27f8002e12af2e35efa8d812a6e20ee7391e610a73e99cf87b474d432e8a14bd7
+  metadata.gz: 05edd6a2285f3921f3501895b13d0d6d1b2b0b615fa2ac5c9248906f65f23e5c0985a0727123a88e90ad3fd3c00f28c6c625d14786de324fa27afc7b28e44757
+  data.tar.gz: 56e2699947955a527b50480439e81ef574a93c2841ff0b19e02b24575b60dd08c95cd94df2f110f7518c9dcbc56b541b6c9c9fe229d1de2615cf801b5b5e442e

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

@@ -1,10 +1,26 @@
-# Usage Guide
+# Getting Started
 
-## What is agent-context?
+This guide explains how to use `agent-context`, a tool for discovering and installing contextual information from Ruby gems to help AI agents.
+
+## Overview
 
 `agent-context` is a tool that helps you discover and install contextual information from Ruby gems for AI agents. Gems can provide additional documentation, examples, and guidance in a `context/` directory.
 
-## Quick Commands
+## Installation
+
+Add the gem to your project:
+
+```bash
+$ bundle add agent-context
+```
+
+Then install agent context files:
+
+```bash
+$ bundle exec bake agent:context:install
+```
+
+## Commands
 
 ```bash
 # See what context is available

data/context/index.yaml

@@ -0,0 +1,13 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Install and manage context files from Ruby gems.
+metadata:
+  documentation_uri: https://ioquatix.github.io/agent-context/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/ioquatix/agent-context.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use `agent-context`, a tool for discovering
+    and installing contextual information from Ruby gems to help AI agents.

data/lib/agent/context/index.rb

@@ -48,6 +48,8 @@ module Agent
 				sections << ""
 				sections << "**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**"
 				sections << ""
+				sections << "**Setup Instructions:** If the referenced files are not present or if dependencies have been updated, run `bake agent:context:install` to install the latest context files."
+				sections << ""
 				
 				gem_contexts = collect_gem_contexts
 				

data/lib/agent/context/installer.rb

@@ -25,7 +25,7 @@ module Agent
 				"troubleshooting",
 				"debugging"
 			]
-
+			
 			# Initialize a new Installer instance.
 			#
 			# @parameter root [String] The root directory to work from (default: current directory).
@@ -37,11 +37,11 @@ module Agent
 			end
 			
 			attr_reader :context_path
-				
+			
 			# Find all gems that have a context directory
 			def find_gems_with_context(skip_local: true)
 				gems_with_context = []
-					
+				
 				@specifications.each do |spec|
 					# Skip gems loaded from current working directory if requested:
 					next if skip_local && spec.full_gem_path == @root
@@ -57,17 +57,17 @@ module Agent
 						}
 					end
 				end
-					
+				
 				gems_with_context
 			end
-				
+			
 			# Find a specific gem with context.
 			def find_gem_with_context(gem_name)
 				spec = @specifications.find {|spec| spec.name == gem_name}
 				return nil unless spec
-					
+				
 				context_path = File.join(spec.full_gem_path, "context")
-					
+				
 				if Dir.exist?(context_path)
 					{
 							name: spec.name,
@@ -80,33 +80,33 @@ module Agent
 					nil
 				end
 			end
-				
+			
 			# List context files for a gem.
 			def list_context_files(gem_name)
 				gem = find_gem_with_context(gem_name)
 				return nil unless gem
-					
+				
 				Dir.glob(File.join(gem[:path], "**/*")).select {|f| File.file?(f)}
 			end
-				
+			
 			# Show content of a specific context file.
 			def show_context_file(gem_name, file_name)
 				gem = find_gem_with_context(gem_name)
 				return nil unless gem
-					
+				
 				# Try to find the file with or without extension:
 				possible_paths = [
 						File.join(gem[:path], file_name),
 						File.join(gem[:path], "#{file_name}.md"),
 						File.join(gem[:path], "#{file_name}.md")
 					]
-					
+				
 				file_path = possible_paths.find {|path| File.exist?(path)}
 				return nil unless file_path
-					
+				
 				File.read(file_path)
 			end
-				
+			
 			# Install context from a specific gem.
 			def install_gem_context(gem_name)
 				gem = find_gem_with_context(gem_name)
@@ -127,18 +127,18 @@ module Agent
 				
 				true
 			end
-				
+			
 			# Install context from all gems.
 			def install_all_context(skip_local: true)
 				gems = find_gems_with_context(skip_local: skip_local)
 				installed = []
-					
+				
 				gems.each do |gem|
 					if install_gem_context(gem[:name])
 						installed << gem[:name]
 					end
 				end
-					
+				
 				installed
 			end
 			
@@ -170,7 +170,6 @@ module Agent
 				
 				{
 					"description" => gem[:summary] || "Context files for #{gem[:name]}",
-					"version" => gem[:version],
 					"metadata" => gem[:metadata],
 					"files" => files
 				}
@@ -183,7 +182,7 @@ module Agent
 				unless File.exist?(index_path)
 					# Generate dynamic index from gemspec
 					index = generate_dynamic_index(gem, gem_directory)
-					
+				
 					# Write the generated index
 					File.write(index_path, index.to_yaml)
 					Console.debug("Generated dynamic index for #{gem[:name]}: #{index_path}")
@@ -196,7 +195,6 @@ module Agent
 				# Return a fallback index
 				{
 					"description" => gem[:summary] || "Context files for #{gem[:name]}",
-					"version" => gem[:version],
 					"metadata" => gem[:metadata],
 					"files" => []
 				}
@@ -251,9 +249,6 @@ module Agent
 				
 				# Join the lines and truncate if too long
 				description = description_lines.join(" ").strip
-				if description.length > 197
-					description = description[0..196] + "..."
-				end
 				
 				description
 			end

data/lib/agent/context/version.rb

@@ -6,6 +6,6 @@
 
 module Agent
 	module Context
-		VERSION = "0.1.3"
+		VERSION = "0.2.1"
 	end
 end 

data/post.md

@@ -90,8 +90,13 @@ my-awesome-gem/
 **Ruby:** "Good question! The generated `agent.md` can be linked to whatever your tool expects:"
 
 **For Cursor:**
-```bash
-ln -s agent.md .cursorrules
+Create `.cursor/rules/agent.mdc` with:
+
+``` markdown
+---
+alwaysApply: true
+---
+Read the `agent.md` file in the project root directory for detailed context relating to this project and external dependencies.
 ```
 
 **For GitHub Copilot:**

data/readme.md

@@ -36,6 +36,10 @@ When you install context from other gems, they will be placed in the `.context/`
 
 ## Usage
 
+Please see the [project documentation](https://ioquatix.github.io/agent-context/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/agent-context/guides/getting-started/index) - This guide explains how to use `agent-context`, a tool for discovering and installing contextual information from Ruby gems to help AI agents.
+
 ### Installation
 
 Add the `agent-context` gem to your project:
@@ -151,7 +155,7 @@ Then create `.cursor/rules/agent.mdc` with:
 ---
 alwaysApply: true
 ---
-Consult the `agent.md` file in the root directory.
+Read the `agent.md` file in the project root directory for detailed context relating to this project and external dependencies.
 ```
 
 This approach uses Cursor's proper front-matter format and directs the AI to consult the main `agent.md` file.
@@ -180,10 +184,25 @@ ln -s agent.md .replit.md
 ln -s agent.md .windsurfrules
 ```
 
+## Releases
+
+Please see the [project releases](https://ioquatix.github.io/agent-context/releases/index) for all releases.
+
+### v0.2.0
+
+  - Don't limit description length.
+
 ## See Also
 
   - [Bake](https://github.com/ioquatix/bake) — The bake task execution tool.
 
+### Gems With Context Files
+
+  - [Async](https://github.com/socketry/async)
+  - [Decode](https://github.com/ioquatix/decode)
+  - [Falcon](https:///github.com/socketry/falcon)
+  - [Sus](https://github.com/socketry/sus)
+
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.2.0
+
+  - Don't limit description length.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agent-context
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -57,9 +57,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- agent.md
 - bake/agent/context.rb
-- context/usage.md
+- context/getting-started.md
+- context/index.yaml
 - lib/agent/context.rb
 - lib/agent/context/index.rb
 - lib/agent/context/installer.rb
@@ -67,6 +67,7 @@ files:
 - license.md
 - post.md
 - readme.md
+- releases.md
 - specification.md
 homepage: https://github.com/ioquatix/agent-context
 licenses:
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Install and manage context files from Ruby gems.
 test_files: []

data/agent.md

@@ -1,39 +0,0 @@
-# Agent
-
-## Context
-
-This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
-
-**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**
-
-### decode
-
-Code analysis for documentation generation.
-
-#### [Getting Started with Decode](.context/decode/getting-started.md)
-
-The Decode gem provides programmatic access to Ruby code structure and metadata. It can parse Ruby files and extract definitions, comments, and documentation pragmas, enabling code analysis, docume...
-
-#### [Documentation Coverage](.context/decode/coverage.md)
-
-This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
-
-#### [Ruby Documentation](.context/decode/ruby-documentation.md)
-
-This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate A...
-
-### sus
-
-A fast and scalable test runner.
-
-#### [Using Sus Testing Framework](.context/sus/usage.md)
-
-Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
-
-#### [Mocking](.context/sus/mocking.md)
-
-There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace m...
-
-#### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
-
-Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.