agent-context 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 788628a6f37f9d5b903a2ff5925198ac462c548c60982dc26bd343c16d3fe385
4
- data.tar.gz: 92906fb976b9190dca498e6c7b1ab8a506c31def843440c244a70fbb0d3bb449
3
+ metadata.gz: 7dcf6ef1ced870cf21a982f53ef4d270621f9b215f2f21084b0f7aff9c71655c
4
+ data.tar.gz: 7ecbef44d024fa43a2dca67bdb2adc3765bb008fa0b36f33a1fd8bef7319286a
5
5
  SHA512:
6
- metadata.gz: 70e275a751175acbbc81843a8a814d0cbf46d009526aa3d21f60332fdaedd9507d63c98ae49a2f5ccf50491aae064a9c50f25f0bba9e050f4d245fb43b6ba55d
7
- data.tar.gz: ff10810cb0cfe267d39c6f57ea6a75b3cc974a42bd20b3440e2f68fbfaf05ea944b6f155f23d3b00c7918ea4610649b7d60d1195a6fcfe9599e95075793a966c
6
+ metadata.gz: 05edd6a2285f3921f3501895b13d0d6d1b2b0b615fa2ac5c9248906f65f23e5c0985a0727123a88e90ad3fd3c00f28c6c625d14786de324fa27afc7b28e44757
7
+ data.tar.gz: 56e2699947955a527b50480439e81ef574a93c2841ff0b19e02b24575b60dd08c95cd94df2f110f7518c9dcbc56b541b6c9c9fe229d1de2615cf801b5b5e442e
checksums.yaml.gz.sig CHANGED
Binary file
@@ -1,10 +1,26 @@
1
- # Usage Guide
1
+ # Getting Started
2
2
 
3
- ## What is agent-context?
3
+ This guide explains how to use `agent-context`, a tool for discovering and installing contextual information from Ruby gems to help AI agents.
4
+
5
+ ## Overview
4
6
 
5
7
  `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.
6
8
 
7
- ## Quick Commands
9
+ ## Installation
10
+
11
+ Add the gem to your project:
12
+
13
+ ```bash
14
+ $ bundle add agent-context
15
+ ```
16
+
17
+ Then install agent context files:
18
+
19
+ ```bash
20
+ $ bundle exec bake agent:context:install
21
+ ```
22
+
23
+ ## Commands
8
24
 
9
25
  ```bash
10
26
  # See what context is available
@@ -0,0 +1,13 @@
1
+ # Automatically generated context index for Utopia::Project guides.
2
+ # Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
3
+ ---
4
+ description: Install and manage context files from Ruby gems.
5
+ metadata:
6
+ documentation_uri: https://ioquatix.github.io/agent-context/
7
+ funding_uri: https://github.com/sponsors/ioquatix/
8
+ source_code_uri: https://github.com/ioquatix/agent-context.git
9
+ files:
10
+ - path: getting-started.md
11
+ title: Getting Started
12
+ description: This guide explains how to use `agent-context`, a tool for discovering
13
+ and installing contextual information from Ruby gems to help AI agents.
@@ -170,7 +170,6 @@ module Agent
170
170
 
171
171
  {
172
172
  "description" => gem[:summary] || "Context files for #{gem[:name]}",
173
- "version" => gem[:version],
174
173
  "metadata" => gem[:metadata],
175
174
  "files" => files
176
175
  }
@@ -196,7 +195,6 @@ module Agent
196
195
  # Return a fallback index
197
196
  {
198
197
  "description" => gem[:summary] || "Context files for #{gem[:name]}",
199
- "version" => gem[:version],
200
198
  "metadata" => gem[:metadata],
201
199
  "files" => []
202
200
  }
@@ -6,6 +6,6 @@
6
6
 
7
7
  module Agent
8
8
  module Context
9
- VERSION = "0.2.0"
9
+ VERSION = "0.2.1"
10
10
  end
11
11
  end
data/readme.md CHANGED
@@ -38,6 +38,8 @@ When you install context from other gems, they will be placed in the `.context/`
38
38
 
39
39
  Please see the [project documentation](https://ioquatix.github.io/agent-context/) for more details.
40
40
 
41
+ - [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.
42
+
41
43
  ### Installation
42
44
 
43
45
  Add the `agent-context` gem to your project:
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: agent-context
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Samuel Williams
@@ -57,9 +57,9 @@ executables: []
57
57
  extensions: []
58
58
  extra_rdoc_files: []
59
59
  files:
60
- - agent.md
61
60
  - bake/agent/context.rb
62
- - context/usage.md
61
+ - context/getting-started.md
62
+ - context/index.yaml
63
63
  - lib/agent/context.rb
64
64
  - lib/agent/context/index.rb
65
65
  - lib/agent/context/installer.rb
metadata.gz.sig CHANGED
Binary file
data/agent.md DELETED
@@ -1,41 +0,0 @@
1
- # Agent
2
-
3
- ## Context
4
-
5
- This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
6
-
7
- **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.**
8
-
9
- **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.
10
-
11
- ### decode
12
-
13
- Code analysis for documentation generation.
14
-
15
- #### [Getting Started with Decode](.context/decode/getting-started.md)
16
-
17
- 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...
18
-
19
- #### [Documentation Coverage](.context/decode/coverage.md)
20
-
21
- This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
22
-
23
- #### [Ruby Documentation](.context/decode/ruby-documentation.md)
24
-
25
- 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...
26
-
27
- ### sus
28
-
29
- A fast and scalable test runner.
30
-
31
- #### [Using Sus Testing Framework](.context/sus/usage.md)
32
-
33
- 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.
34
-
35
- #### [Mocking](.context/sus/mocking.md)
36
-
37
- 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...
38
-
39
- #### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
40
-
41
- 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.