x_aeon_agents 1.0.28

data/lib/x_aeon_agents/agents/readme/contributing_agent.rb

@@ -0,0 +1,47 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Contributing" section of a README.
+      class ContributingAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            contributing: {
+              description: 'The "Contributing" section content in Markdown format, explaining how to contribute to the project',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Contributing',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's CONTRIBUTING guidelines, issue templates, pull request templates, and any community guidelines.
+              Generate a "Contributing" section in Markdown format, compatible with Github flavor, explaining how users can contribute to the project.
+              Focus on giving community specific guidelines (issues, pull requests, CI, fork...).
+              Use emphasis, bullet points, useful links to the project resources and small emojis to better format your section.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+              - Do not describe the technical setup or prequisites, as they are already covered by other sections.
+              - Do not cover how to develop in this project: it is already covered in other sections.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/development_agent.rb

@@ -0,0 +1,54 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Development" section of a README.
+      class DevelopmentAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            development: {
+              description: 'The "Development" section content in Markdown format, explaining how to set up a development environment and contribute code',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Development',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's development setup, build system, testing framework, and development workflows.
+              Generate a "Development" section in Markdown format, compatible with Github flavor, explaining how to set up a development environment and how to code in it.
+              This section is intended for developers.
+              Explain how to:
+              - clone the repository,
+              - install test-specific dependencies if any,
+              - run tests,
+              - use code lint if any,
+              - navigate the project structure (high-level, no need for details),
+              - package the project deliverables,
+              - perform common development tasks.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+              - Do not cover the end-user main requirements and prerequisites: they are already covered in other sections.
+              - Do not cover the contribution workflow (pull requests, CI, issues...): this is already covered in other sections.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/documentation_agent.rb

@@ -0,0 +1,43 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Documentation" section of a README.
+      class DocumentationAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            documentation: {
+              description: 'The "Documentation" section content in Markdown format, providing links to documentation resources of the project',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Documentation',
+            objective: <<~EO_OBJECTIVE,
+              Explore the project's documentation files and resources to identify all available documentation.
+              Generate a "Documentation" section in Markdown format, compatible with Github flavor, providing links to documentation resources.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/features_agent.rb

@@ -0,0 +1,45 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Features" section of a README.
+      class FeaturesAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            features: {
+              description: 'The "Features" section content in Markdown format, listing the key features of the project',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Features',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's codebase and capabilities to identify all key features.
+              Generate a "Features" section in Markdown format, compatible with Github flavor, listing the main features of the project.
+              Use emphasis, bullet points and small emojis to illustrate in a readable way the list of features.
+              Don't provide an overall description of the project: another section is already doing it.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/how_it_works_agent.rb

@@ -0,0 +1,47 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "How it works" section of a README.
+      class HowItWorksAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            how_it_works: {
+              description: 'The "How it works" section content in Markdown format, explaining the internal architecture and working principles of the project',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'How it works',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's architecture, design patterns, and internal workings.
+              Generate a "How it works" section in Markdown format, compatible with Github flavor, explaining the internal architecture and working principles.
+              Use emphasis, bullet points, useful links to the project resources and small emojis to better format your section.
+              You can use SocratiCode if it is available to get a better understanding of this project.
+              You can use Mermaid graphs to also illustrate the way this project works.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+              - Do not provide long paragraphs: focus on readability by splitting long paragraphs into several short ones.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/license_agent.rb

@@ -0,0 +1,43 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "License" section of a README.
+      class LicenseAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            license: {
+              description: 'The "License" section content in Markdown format, describing the project license information',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'License',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's LICENSE file to identify the license type and terms.
+              Generate a "License" section in Markdown format, compatible with Github flavor, describing the project license.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/public_api_agent.rb

@@ -0,0 +1,44 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Public API" section of a README.
+      class PublicApiAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            public_api: {
+              description: 'The "Public API" section content in Markdown format, describing the public API surface of the project',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Public API',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's codebase to identify all public APIs, classes, methods, and interfaces exposed to users.
+              Generate a "Public API" section in Markdown format, compatible with Github flavor, documenting the public API surface.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+              - Only document public API entry points: executables and library public methods belonging to yarn `Public API` group.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/quick_start_agent.rb

@@ -0,0 +1,50 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Quick start" section of a README.
+      class QuickStartAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            quick_start: {
+              description: 'The "Quick start" section content in Markdown format, providing quick installation and usage instructions',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Quick Start',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's installation and usage patterns to provide quick installation and usage instructions.
+              Generate a "Quick start" section in Markdown format, compatible with Github flavor.
+              Focus on the precise steps that allow an external end user to use this project.
+              For examples:
+              - If this project is a Rubygem, explain how to install and use this Rubygem in an application.
+              - If this project exposes CLI, explain how to install it in a user's system and how to invoke them.
+              - If this project defines a web app, explain how to install this web app, run it and access it using a web browser.
+              This section should be concise: don't cover all features, just simple install and startup guides for the main happy paths.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+              - This section is not meant for developers: don't describe how to develop, test, document, package or contribute to this project.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end

data/lib/x_aeon_agents/agents/readme/requirements_agent.rb

@@ -0,0 +1,43 @@
+module XAeonAgents
+  module Agents
+    module Readme
+      # Agent responsible for generating the "Requirements" section of a README.
+      class RequirementsAgent < ComposableAgents::Cline::Agent
+        prepend AgentDefaults
+
+        # Define output artifacts contracts
+        #
+        # @return [Hash{Symbol => Object}] Set of output artifacts description, per artifact name
+        def output_artifacts_contracts
+          super.merge(
+            requirements: {
+              description: 'The "Requirements" section content in Markdown format, describing the prerequisites needed to use the project',
+              type: :markdown
+            }
+          )
+        end
+
+        # Constructor
+        #
+        # @param agent_params [Hash{Symbol => Object}] Extra agent parameters
+        def initialize(**agent_params)
+          super(
+            name: 'Requirements',
+            objective: <<~EO_OBJECTIVE,
+              Analyze the project's dependencies, runtime environment, and prerequisites.
+              Generate a "Requirements" section in Markdown format, compatible with Github flavor, listing all prerequisites needed to use or run the project.
+            EO_OBJECTIVE
+            constraints: <<~EO_CONSTRAINTS,
+              - The required output artifact content should only contain the required content, without additional header or title.
+              - Do not explain or describe the artifact content: only provide the content as required.
+              - Only focus on the specific scope of the required documentation required.
+                Other agents will generate other sections of the README.
+                Do not try to document other parts.
+            EO_CONSTRAINTS
+            **agent_params
+          )
+        end
+      end
+    end
+  end
+end