> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Test Documentation

> Reference page demonstrating AGENTS.md documentation standards

This page demonstrates the AGENTS.md documentation template — agent-centric examples, Mintlify components, and standard diagrams.

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent

agent = Agent(
    name="Doc Tester",
    instructions="Summarise documentation standards in one paragraph.",
)
agent.start("What makes good agent documentation?")
```

The user reads a reference page; the hero example and diagram show how feature docs should open with Agent code and a user flow.

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
graph LR
    subgraph "Documentation Workflow"
        SDK[📦 SDK Source] --> Agent[🤖 Agent Example]
        Agent --> Page[📄 Feature Page]
        Page --> Review[✅ AGENTS.md Checklist]
    end

    classDef sdk fill:#6366F1,stroke:#7C90A0,color:#fff
    classDef agent fill:#8B0000,stroke:#7C90A0,color:#fff
    classDef page fill:#189AB4,stroke:#7C90A0,color:#fff
    classDef review fill:#10B981,stroke:#7C90A0,color:#fff

    class SDK sdk
    class Agent agent
    class Page page
    class Review review
```

## Quick Start

<Steps>
  <Step title="Agent-Centric Intro">
    Every page opens with a minimal `Agent(...)` example before the hero diagram.

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    from praisonaiagents import Agent

    agent = Agent(name="Example", instructions="Demonstrate the feature.")
    agent.start("Hello")
    ```
  </Step>

  <Step title="Mintlify Structure">
    Wrap Quick Start in Steps, Best Practices in AccordionGroup, and Related links in CardGroup (cols=2).

    ```mdx theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    <Steps>
      <Step title="Simple Usage">...</Step>
      <Step title="With Configuration">...</Step>
    </Steps>
    ```
  </Step>
</Steps>

***

## How It Works

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
sequenceDiagram
    participant Author
    participant SDK
    participant Page
    participant Reader

    Author->>SDK: Read source code
    SDK-->>Author: APIs and defaults
    Author->>Page: Write agent-centric docs
    Page-->>Reader: Copy-paste examples
```

| Component               | Purpose               | Output                   |
| ----------------------- | --------------------- | ------------------------ |
| **SDK source**          | Ground truth for APIs | Accurate examples        |
| **Agent example**       | Simplest usage path   | Quick Start code         |
| **Mintlify components** | Consistent layout     | Steps, Accordions, Cards |

***

## Best Practices

<AccordionGroup>
  <Accordion title="Start with Agent(...)">
    Top of every page: a minimal agent example showing the feature in use — not subsystem imports or config-only snippets.
  </Accordion>

  <Accordion title="Use standard diagram colours">
    Hero Mermaid diagrams use `#8B0000` for agents, `#189AB4` for tools/processes, and white text on coloured fills.
  </Accordion>

  <Accordion title="Keep examples runnable">
    Include all imports, use `os.getenv()` for secrets, and avoid placeholder strings like `"your-api-key"`.
  </Accordion>

  <Accordion title="One sentence per section intro">
    Each section gets a single sentence explaining what follows — no preamble phrases from AGENTS.md §6.3.
  </Accordion>
</AccordionGroup>

***

## Related

<CardGroup cols={2}>
  <Card title="Templates" icon="file-code" href="/docs/features/templates">
    Customise agent prompts and response formatting
  </Card>

  <Card title="Telemetry" icon="chart-line" href="/docs/features/telemetry">
    Anonymous usage metrics for agent runs
  </Card>
</CardGroup>