Mintlify Author

Technical writer specializing in Mintlify documentation sites, developer experience, and product documentation.

Quick Reference

Property	Value
Domain	Documentation
FORGE Stage	5 (VERIFY)
Version	1.0.0
Output Types	MDX pages, navigation config

Overview

Use this agent when you need to:

Create Mintlify MDX documentation pages
Structure docs with logical navigation
Write developer guides with code examples
Use Mintlify components (Cards, Steps, Tabs, Accordions)
Update mint.json navigation structure
Create API reference pages from OpenAPI specs

The Mintlify Author creates comprehensive, well-structured documentation for docs.so1.io using MDX and Mintlify’s component library.

Core Capabilities

Page Creation

Write MDX documentation pages with Mintlify components

Navigation Design

Structure docs with logical information architecture

Code Examples

Create runnable, tested code samples in multiple languages

Component Usage

Leverage Mintlify’s built-in components effectively

When to Use

Feature implementation complete, needs user documentation

API endpoints require reference pages

New integration needs setup guide

Tutorial or walkthrough needed

Documentation navigation needs restructuring

Existing docs need Mintlify component updates

Usage Examples

Getting Started Guide
API Endpoint Page
Troubleshooting Guide

Create an onboarding guide with Steps component:

---
title: "Getting Started"
description: "Set up SO1 and create your first workflow in 5 minutes"
icon: "rocket"
---

# Getting Started with SO1

<Info>
  **Prerequisites**: You'll need a GitHub account to sign up.
</Info>

<Steps>
  <Step title="Create your account">
    Visit [console.so1.io](https://console.so1.io) and click **Sign up with GitHub**.
  </Step>
  
  <Step title="Create an organization">
    Organization names must be unique and URL-safe.
    
    ```bash
    my-company  ✓
    My Company  ✗ (no spaces)
    ```
  </Step>
  
  <Step title="Create your first workflow">
    <CardGroup cols={2}>
      <Card title="GitHub Issue Sync" icon="github">
        Sync GitHub issues to your PM tool
      </Card>
      <Card title="Slack Notifications" icon="slack">
        Get notified when events happen
      </Card>
    </CardGroup>
  </Step>
</Steps>

## What's Next?

<CardGroup cols={2}>
  <Card title="Concepts" icon="book" href="/concepts">
    Learn about workflows and triggers
  </Card>
  <Card title="API Reference" icon="code" href="/api-reference">
    Integrate SO1 into your apps
  </Card>
</CardGroup>

Result: Interactive, step-by-step onboarding guide with visual cards.

Document an API endpoint with request/response examples:

---
title: "Create Workflow"
api: "POST /api/v1/workflows"
description: "Create a new automation workflow"
---

# Create Workflow

<Info>
  **Authentication required**: Include API key in `Authorization` header.
</Info>

## Request Parameters

<ParamField body="name" type="string" required>
  Workflow display name (1-100 characters)
</ParamField>

<ParamField body="triggerType" type="string" default="manual">
  How workflow is triggered: `manual`, `webhook`, `schedule`, `event`
</ParamField>

<ParamField body="triggerConfig" type="object">
  Trigger-specific configuration
  
  <Expandable title="For schedule triggers">
    <ParamField body="cron" type="string" required>
      Cron expression (e.g., `0 9 * * 1-5`)
    </ParamField>
  </Expandable>
</ParamField>

<RequestExample>
```bash cURL
curl -X POST https://api.so1.io/api/v1/workflows \
  -H "Authorization: Bearer sk_live_xxx" \
  -d '{"name": "Daily Report", "triggerType": "schedule"}'
```

```typescript TypeScript
const workflow = await so1.workflows.create({
  name: 'Daily Report',
  triggerType: 'schedule',
});
```
</RequestExample>

<ResponseExample>
```json 201 Created
{
  "success": true,
  "data": {
    "id": "wf_abc123",
    "name": "Daily Report",
    "status": "draft"
  }
}
```
</ResponseExample>

Result: Complete API documentation with interactive code examples.

Create a troubleshooting page with Accordions:

---
title: "Troubleshooting"
description: "Common issues and solutions"
icon: "wrench"
---

# Troubleshooting

<AccordionGroup>
  <Accordion title="Workflow not triggering">
    **Symptoms**: Scheduled workflow not executing
    
    **Solution**:
    1. Verify cron expression is valid
    2. Check timezone configuration
    3. Ensure workflow status is "active"
    
    <Tip>
      Use [crontab.guru](https://crontab.guru) to validate cron expressions
    </Tip>
  </Accordion>

  <Accordion title="API returns 401 Unauthorized">
    **Symptoms**: API requests fail with 401
    
    **Solution**:
    - Check API key is valid: `sk_live_*` or `sk_test_*`
    - Ensure key is in Authorization header: `Bearer <key>`
    - Verify key has not been revoked
  </Accordion>
</AccordionGroup>

<Warning>
  If issues persist, [contact support](mailto:support@so1.io)
</Warning>

Result: Searchable troubleshooting guide with collapsible sections.

Outputs

Mintlify Components Reference

Component	Use Case
`<Info>`	Helpful context, prerequisites
`<Warning>`	Important cautions
`<Tip>`	Best practices, shortcuts
`<Card>` / `<CardGroup>`	Feature highlights, navigation
`<Steps>` / `<Step>`	Sequential instructions
`<Tabs>` / `<Tab>`	Alternative content views
`<Accordion>` / `<AccordionGroup>`	Collapsible details
`<CodeGroup>`	Multiple language examples
`<ParamField>`	API parameter documentation
`<RequestExample>` / `<ResponseExample>`	API examples

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "SO1 Documentation",
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "introduction",
        "quickstart",
        "concepts"
      ]
    },
    {
      "group": "API Reference",
      "pages": [
        "api-reference/authentication",
        {
          "group": "Workflows",
          "pages": [
            "api-reference/workflows/list",
            "api-reference/workflows/create"
          ]
        }
      ]
    }
  ]
}

FORGE Gate Compliance

Entry Gates

Feature implementation complete

The feature or API must be fully implemented and tested before documentation begins.

API endpoints documented (OpenAPI)

For API docs, OpenAPI spec must be available from API Documenter agent.

Target audience identified

Know whether writing for developers, operators, or end-users.

Exit Gates

MDX pages created

All required pages created in correct directory with proper frontmatter.

Navigation structure updated

Code examples validated

All code examples tested and working.

Internal links validated

No broken links to other pages or anchors.

Agent	Relationship
API Documenter	Provides OpenAPI specs for API reference pages
Hono Backend	Source of API implementations to document
Next.js Frontend	Source of UI features to document

Source Files

View Agent Source

Repository: so1-io/so1-agents
Path: agents/documentation/mintlify-author.md
Version: 1.0.0

Agents Overview

Orchestration

Automation

Engineering

DevOps

Documentation

Prompts

Incident

Mintlify Author

Mintlify Author

Quick Reference

Overview

Core Capabilities

Page Creation

Navigation Design

Code Examples

Component Usage

When to Use

Usage Examples

Outputs

Mintlify Components Reference

Navigation Configuration

FORGE Gate Compliance

Entry Gates

Exit Gates

Source Files

View Agent Source

Agents Overview

Orchestration

Automation

Engineering

DevOps

Documentation

Prompts

Incident

​Mintlify Author

​Quick Reference

​Overview

​Core Capabilities

Page Creation

Navigation Design

Code Examples

Component Usage

​When to Use

​Usage Examples

​Outputs

​Mintlify Components Reference

​Navigation Configuration

​FORGE Gate Compliance

​Entry Gates

​Exit Gates

​Related Agents

​Source Files

View Agent Source

Mintlify Author

Quick Reference

Overview

Core Capabilities

When to Use

Usage Examples

Outputs

Mintlify Components Reference

Navigation Configuration

FORGE Gate Compliance

Entry Gates

Exit Gates

Related Agents

Source Files