Complete Documentation

Installation

AIRanky can be installed automatically through the WordPress admin or manually uploaded to your server.

Automatic Installation (Recommended)

1. Go to Plugins > Add New in your WordPress admin
2. Search for "AIRanky"
3. Click Install Now and then Activate

Manual Installation

1. Download the plugin zip file
2. Go to Plugins > Add New > Upload Plugin in your WordPress admin
3. Choose the downloaded file and click Install Now
4. Click Activate Plugin

Getting Started

After installation, follow these steps to set up AIRanky for your website.

Initial Setup

1. Navigate to AIRanky Dashboard - Go to the AIRanky menu in your WordPress admin
2. Generate Your Files - Click the generation buttons to create your AI-optimized files
3. Configure Settings - Customize post types, update frequency, and AI bot rules
4. Monitor & Maintain - Use the Tools page to validate files and view activity logs

Generated Files

AIRanky creates three main files for AI optimization:

• sitemap-ai.xml - AI-optimized sitemap with metadata
• llms.txt - Structured content index for AI training
• robots.txt - Safe AI bot access management

Configuration

Customize AIRanky settings to match your website's needs and preferences.

Sitemap AI Settings

LLMS.txt Configuration

Configure structured content organization for AI models:

• Category and tag grouping
• Content type definitions
• Custom metadata fields
• AI model compatibility settings

Robots.txt Management

Safe AI bot access configuration:

• AI bot user-agent rules
• Path allow/disallow settings
• Safe marker system for non-conflicting rules
• Automatic cleanup on deactivation

REST API Reference

AIRanky provides REST API endpoints for programmatic access to sitemap generation, file management, and status monitoring.

Available Endpoints

Hooks & Filters

AIRanky provides extensive hooks and filters for developers to customize functionality.

Available Filters

add_filter('airanky_sitemap_content', function($content) {
    // Modify sitemap content
    return $modified_content;
});

add_filter('airanky_llms_content', function($content) {
    // Modify llms.txt content
    return $modified_content;
});

add_filter('airanky_robots_rules', function($rules) {
    // Modify robots.txt rules
    return $modified_rules;
});

add_filter('airanky_post_types', function($post_types) {
    // Add or remove post types
    return $post_types;
});

add_filter('airanky_exclude_posts', function($excluded_posts) {
    // Add posts to exclude
    $excluded_posts[] = 123; // Post ID
    return $excluded_posts;
});

Code Examples

Practical examples of how to use AIRanky hooks and filters in your themes and plugins.

Custom Sitemap Content

add_filter('airanky_sitemap_content', function($content) {
    // Add custom pages to sitemap
    $custom_pages = [
        'about' => [
            'url' => home_url('/about/'),
            'lastmod' => date('Y-m-d'),
            'priority' => '0.8',
            'changefreq' => 'monthly'
        ]
    ];
    
    foreach ($custom_pages as $page) {
        $content .= "<url>\n";
        $content .= "    <loc>{$page['url']}</loc>\n";
        $content .= "    <lastmod>{$page['lastmod']}</lastmod>\n";
        $content .= "    <priority>{$page['priority']}</priority>\n";
        $content .= "    <changefreq>{$page['changefreq']}</changefreq>\n";
        $content .= "</url>\n";
    }
    
    return $content;
});

Custom LLMS.txt Content

add_filter('airanky_llms_content', function($content) {
    // Add custom content sections
    $custom_sections = [
        'Custom Resources' => [
            'description' => 'Additional resources for AI training',
            'urls' => [
                home_url('/api/docs/'),
                home_url('/data-sets/'),
                home_url('/research/')
            ]
        ]
    ];
    
    foreach ($custom_sections as $title => $section) {
        $content .= "\n## {$title}\n";
        $content .= "{$section['description']}\n\n";
        foreach ($section['urls'] as $url) {
            $content .= "- {$url}\n";
        }
    }
    
    return $content;
});

Custom Robots.txt Rules

add_filter('airanky_robots_rules', function($rules) {
    // Add custom AI bot rules
    $custom_rules = [
        'User-agent: CustomAIBot',
        'Allow: /public-content/',
        'Disallow: /private-content/',
        'Crawl-delay: 1'
    ];
    
    $rules = array_merge($rules, $custom_rules);
    return $rules;
});

Troubleshooting

Common issues and their solutions when using AIRanky.

Common Issues

Debug Mode

Enable debug mode to get detailed information about file generation:

// Add to wp-config.php
define('AIRANKY_DEBUG', true);