Test Documentation

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

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.

Quick Start

Agent-Centric Intro

Every page opens with a minimal Agent(...) example before the hero diagram.

from praisonaiagents import Agent

agent = Agent(name="Example", instructions="Demonstrate the feature.")
agent.start("Hello")

Mintlify Structure

Wrap Quick Start in Steps, Best Practices in AccordionGroup, and Related links in CardGroup (cols=2).

<Steps>
  <Step title="Simple Usage">...</Step>
  <Step title="With Configuration">...</Step>
</Steps>

How It Works

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

Opting an Example Out of the Guard

The SDK’s session-docs guard executes every self-contained Python example in praisonaiagents/session/README.md; drop  on the line above a fence to opt an example out.

<!-- praisonai: skip=true -->
```python
from praisonaiagents.session import DefaultSessionStore

store = DefaultSessionStore(session_dir="/custom/path/sessions")
```

The directive is an HTML comment placed within five lines above the fence. Accepted spellings are case-insensitive: skip=true, skip=1, skip=yes.

When to use it

Use the directive when an example:

writes to an absolute path outside the temp dir,
reads a live secret or credential,
starts a long-running server or opens a socket.

For a deliberate fragment, prefer letting the free-name filter drop it — no directive needed.

When not to use it

“It doesn’t run in my env” is not a reason. If the example is real, make it hermetic.
Don’t use it to hide a broken example. The guard exists so the docs stay honest.

The executor lives at src/praisonai-agents/tests/unit/session/test_session_docs_examples.py, introduced in PraisonAI PR #4179.

Best Practices

Start with Agent(...)

Top of every page: a minimal agent example showing the feature in use — not subsystem imports or config-only snippets.

Use standard diagram colours

Hero Mermaid diagrams use #8B0000 for agents, #189AB4 for tools/processes, and white text on coloured fills.

Keep examples runnable

Include all imports, use os.getenv() for secrets, and avoid placeholder strings like "your-api-key".

One sentence per section intro

Each section gets a single sentence explaining what follows — no preamble phrases from AGENTS.md §6.3.

Templates

Customise agent prompts and response formatting

Telemetry

Anonymous usage metrics for agent runs

Getting Started

Install

Core Concepts

Guides

Features

Models

Databases

Observability

Memory

Telemetry & Analytics

Knowledge

RAG

Persistence

Tools

Other Features

Developers

Configuration

Best Practices

Getting Started (No Code)

Test Documentation

Quick Start

How It Works

Opting an Example Out of the Guard

When to use it

When not to use it

Best Practices

Templates

Telemetry

​Quick Start

​How It Works

​Opting an Example Out of the Guard

​When to use it

​When not to use it

​Best Practices

​Related

Templates

Telemetry

Quick Start

How It Works

Opting an Example Out of the Guard

When to use it

When not to use it

Best Practices

Related