​

Mintlify Deployment Guide

​

Setup & Configuration

​

1. Interactive API Playground Configuration

{
  "api": {
    "playground": {
      "display": "interactive"
    },
    "examples": {
      "languages": ["curl", "python", "javascript", "php"],
      "defaults": "required"
    }
  }
}

​

2. Auto-Generated API Reference

{
  "tab": "API Reference",
  "openapi": "openapi.yaml"
}

• Live testing capabilities
• Request/response examples
• Schema validation
• Multi-language code generation

​

Manual Deployment Trigger

curl --request POST \
  --url "https://api.mintlify.com/v2/project/update/{projectId}" \
  --header "Authorization: Bearer YOUR_MINTLIFY_TOKEN" \
  --header "Content-Type: application/json"

​

Development Workflow

​

1. Local Development

# Install Mintlify CLI
npm i -g mintlify

# Start local development server
cd /path/to/PulseGuardDocs
mintlify dev

​

2. Test API Playground Locally

• Navigate to http://localhost:3000
• Go to API Reference tab
• Test interactive endpoints
• Verify all authentication methods work
• Check code generation for all languages

​

3. Content Validation

# Check for broken links
mintlify broken-links

# Validate OpenAPI spec
mintlify validate

​

New Documentation Features

​

Enhanced API Playground

• Interactive Testing: Test all endpoints directly in browser
• Multi-language Examples: Automatic code generation in curl, Python, JavaScript, and PHP
• Authentication Support: Built-in support for Bearer tokens and Agent authentication
• Real-time Validation: Live schema validation for requests and responses

​

Comprehensive Changelog

• Version History: Detailed changelog with all features and improvements
• Migration Guide: Instructions for API version upgrades
• Breaking Changes: Clear documentation of breaking changes

​

Developer Resources

• Quick Start Examples: Ready-to-use code snippets for all major features
• Advanced Patterns: Webhook integration, batch operations, error handling
• Best Practices: Security, performance, and monitoring guidelines
• Rate Limiting: Detailed information about API limits per plan

​

Automatic Updates

• New endpoints appear automatically
• Schema changes are reflected immediately
• Deprecated endpoints are marked appropriately
• Examples stay in sync with API changes

​

Quality Assurance Checklist

• All API endpoints are properly documented in openapi.yaml
• Interactive playground works for all endpoints
• Code examples generate correctly for all languages
• Authentication flows are properly configured
• Changelog is updated with latest changes
• All links are working (run mintlify broken-links)
• Local preview looks correct (mintlify dev)

​

Monitoring & Maintenance

​

Regular Tasks

1. Monthly: Update changelog with new features
2. Quarterly: Review API documentation for accuracy
3. On API Changes: Update OpenAPI spec immediately
4. On Breaking Changes: Update migration guides

​

Performance Monitoring

• Monitor page load times
• Check API playground response times
• Validate all interactive features work
• Test authentication flows regularly

​

Support & Troubleshooting

​

Common Issues

• Check OpenAPI spec is valid
• Verify authentication configuration
• Test locally with mintlify dev

• Ensure languages array in docs.json is correct
• Verify OpenAPI spec has proper examples
• Check for CORS issues with API endpoints

• Run mintlify broken-links to identify issues
• Update outdated internal links
• Verify external links are still valid

​

Getting Help

• Mintlify Documentation: docs.mintlify.com
• Mintlify Support: mintlify.com/support
• PulseGuard Team: [email protected]