Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.praison.ai/llms.txt

Use this file to discover all available pages before exploring further.

Test documentation demonstrates the complete documentation engineering workflow with proper structure, Mermaid diagrams, and agent-centric examples.

​
Quick Start

1

Simple Usage

Create a basic agent with test documentation features enabled:
from praisonaiagents import Agent

agent = Agent(
    name="Test Agent",
    instructions="You are a test documentation agent that demonstrates features",
    test_mode=True  # Enable test mode
)

result = agent.start("Generate a simple test report")
print(result)
2

With Configuration

Configure test documentation with custom settings:
from praisonaiagents import Agent

# Custom configuration for test documentation
test_config = {
    "validation": True,
    "reporting": True,
    "metrics": True
}

agent = Agent(
    name="Advanced Test Agent",
    instructions="You are an advanced test documentation agent",
    test_mode=test_config
)

result = agent.start("Generate a comprehensive test analysis")
print(result)

​
How It Works

ComponentPurposeOutput
UserInitiates test requestRequirements
AgentProcesses and validatesAnalysis
TestDocsGenerates documentationReports

​
Configuration Options

Test Documentation API Reference

Python configuration options for test documentation

​
Common Patterns

​
Pattern 1: Basic Test Documentation

from praisonaiagents import Agent

# Simple test documentation setup
agent = Agent(
    name="Documentation Tester",
    instructions="Test and document features systematically",
    test_mode=True
)

# Generate test documentation
result = agent.start("Document the agent initialization process")

​
Pattern 2: Advanced Test Validation

from praisonaiagents import Agent

# Advanced test with validation
agent = Agent(
    name="Validation Tester",
    instructions="Test features with comprehensive validation",
    test_mode={
        "validation": True,
        "error_checking": True,
        "performance_metrics": True
    }
)

# Run comprehensive tests
result = agent.start("Validate all agent features and generate report")

​
Pattern 3: Multi-Agent Test Documentation

from praisonaiagents import Agent, AgentTeam

# Create specialized test agents
doc_agent = Agent(
    name="Documentation Agent",
    instructions="Focus on documentation quality",
    test_mode=True
)

test_agent = Agent(
    name="Test Agent", 
    instructions="Focus on test execution",
    test_mode=True
)

# Coordinate testing
team = AgentTeam(agents=[doc_agent, test_agent])
result = team.start("Generate comprehensive test documentation")

​
Best Practices

Always follow the AGENTS.md page structure template with proper frontmatter, hero diagrams, Quick Start section, How It Works section, and Best Practices section using Mintlify components.
Start every documentation page with agent-centric Quick Start examples that show the simplest way to use the feature, followed by more advanced configuration examples.
Use the standard color scheme: #8B0000 (dark red) for agents, #189AB4 (teal) for tools/processes, #fff (white) for text, ensuring all diagrams are visually consistent.
Ensure all code examples are copy-paste runnable with correct imports, use realistic but simple data, and represent the shortest way to accomplish the task.

Agents

Learn about agent fundamentals and core concepts

Tools

Discover available tools and how to use them