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.

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

1. 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")

2. 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

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 <!-- praisonai: skip=true --> 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.

Best Practices

Related