freemo
e54818d5cb
Extend the UAT testing agents to capture successful test workflows and automatically generate showcase documentation demonstrating real-world usage of CleverAgents. Key features added: - Documentation generation when tests succeed end-to-end - Intelligent duplicate detection to avoid redundant examples - Categorization into cli-tools, api-clients, data-processing, testing-tools - Automatic PR creation for new documentation examples - Integration with existing UAT workflow without disruption Documentation structure: - New docs/showcase/ directory for real-world examples - Category-specific subdirectories with README guides - Example template for consistent formatting - JSON index for tracking and duplicate detection The UAT tester now serves dual purposes: 1. Finding bugs through comprehensive testing (existing behavior) 2. Generating high-quality documentation from successful test runs (new) This enables the system to build its own showcase of capabilities while performing regular quality assurance, providing valuable examples for users and demonstrating the system's practical applications.
2.3 KiB
[Example Title - e.g., "Building a Simple Todo CLI App"]
Overview
[Brief 2-3 sentence description of what this example demonstrates and why it's useful. Focus on the practical value and what the user will learn.]
Prerequisites
- CleverAgents installed (
pip install cleveragents) - Python 3.12 or higher
- [Any additional requirements specific to this example]
What You'll Build
[Detailed description of the end result - what will the user have when they complete this example? Include key features and capabilities.]
Step-by-Step Walkthrough
Step 1: [Initialize the Project]
$ agents [command with arguments]
Expected Output:
[Actual output from the UAT test run]
What's Happening: [Explanation of what CleverAgents is doing at this step - help the user understand the system's behavior]
Step 2: [Define the Core Functionality]
$ agents [next command]
Expected Output:
[Actual output]
What's Happening: [Explanation of this step's purpose and what's being created]
Step 3: [Add Features/Test/Deploy]
$ agents [command]
Expected Output:
[Output showing success]
What's Happening: [Explanation of final steps]
Testing Your Creation
Running the Application
$ [command to run the created app]
Example Usage:
[Show the app in action with sample inputs/outputs]
Complete Interaction Log
Click to see the full CleverAgents session log
[Timestamp] Starting CleverAgents session...
[Timestamp] User: agents [initial command]
[Timestamp] CleverAgents: [response]
[... complete timestamped interaction log ...]
[Timestamp] Session completed successfully.
Key Takeaways
- [Important concept or pattern demonstrated]
- [Best practice illustrated]
- [Feature of CleverAgents highlighted]
- [Common use case addressed]
Try It Yourself
Now that you've seen how to [what was built], try these variations:
- [Suggested modification 1]
- [Suggested modification 2]
- [Challenge: Advanced variation]
Related Examples
- [Link to similar example if exists]
- [Link to more advanced example if exists]
This example was automatically generated and verified by the CleverAgents UAT system. Feature area: [area] | Test cycle: [N] | Generated: [timestamp]