block / block/trailblaze

Documentation Improvement: Add Examples for Custom TrailblazeTool Creation

Open
#74 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
310
Forks
28
Avg merge
7h 45m
Merged PRs (30d)
8

Description

# Documentation Improvement: Add Examples for Custom TrailblazeTool Creation

## Background
The README provides a great overview of the features of Trailblaze, including the ability to extend functionality using custom `TrailblazeTool`s. However, it lacks specific examples or a step-by-step guide on how developers can create their own custom tools for the agent.

## Suggested Enhancement
To enhance the documentation, I suggest adding a dedicated section that includes:
- A brief introduction to what a `TrailblazeTool` is and its benefits.
- Clear, annotated code examples showing how to create a simple `TrailblazeTool`.
- Instructions on how to integrate the custom tool into the Trailblaze framework.
- Use cases where custom tools can significantly enhance testing capabilities.

This enhancement would help new users understand the extensibility of Trailblaze better, encouraging more contributions and adoption of the framework.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.