8c7cd24685
Major refactoring to create a clean, integrated CLI application: ### New Features: - Unified CLI executable (./seo) with simple command structure - All commands accept optional CSV file arguments - Auto-detection of latest files when no arguments provided - Simplified output directory structure (output/ instead of output/reports/) - Cleaner export filename format (all_posts_YYYY-MM-DD.csv) ### Commands: - export: Export all posts from WordPress sites - analyze [csv]: Analyze posts with AI (optional CSV input) - recategorize [csv]: Recategorize posts with AI - seo_check: Check SEO quality - categories: Manage categories across sites - approve [files]: Review and approve recommendations - full_pipeline: Run complete workflow - analytics, gaps, opportunities, report, status ### Changes: - Moved all scripts to scripts/ directory - Created config.yaml for configuration - Updated all scripts to use output/ directory - Deprecated old seo-cli.py in favor of new ./seo - Added AGENTS.md and CHANGELOG.md documentation - Consolidated README.md with updated usage ### Technical: - Added PyYAML dependency - Removed hardcoded configuration values - All scripts now properly integrated - Better error handling and user feedback Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
4.9 KiB
4.9 KiB
Documentation - Rank Math API Manager Plugin
📚 Documentation Overview
Welcome to the comprehensive documentation for the Rank Math API Manager plugin. This documentation is organized to help you get started quickly and find the information you need.
📖 Available Guides
🚀 Getting Started
- Installation Guide - Complete installation and setup instructions
- API Documentation - Complete technical API reference
- Example Use Cases - Practical examples and scenarios
🔧 Integration & Development
- Integration Guide - Step-by-step integration with n8n, Zapier, Make, and custom applications
- Troubleshooting Guide - Common issues and solutions
- Security Guide - Security best practices and configuration
📋 Reference
- Changelog - Version history and changes
- Security Policy - Security policy and vulnerability reporting
- Code of Conduct - Community guidelines
🎯 Quick Start
1. Installation
- Follow the Installation Guide to set up the plugin
- Configure WordPress Application Passwords
- Test the API endpoint
2. Basic Usage
# Update SEO metadata for a post
curl -X POST "https://your-site.com/wp-json/rank-math-api/v1/update-meta" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Authorization: Basic [your-credentials]" \
-d "post_id=123&rank_math_title=Your SEO Title&rank_math_description=Your meta description"
3. Integration
- n8n: See Integration Guide
- Zapier: See Integration Guide
- Python: See Integration Guide
🔍 Finding What You Need
By Task
| Task | Documentation |
|---|---|
| Install the plugin | Installation Guide |
| Understand the API | API Documentation |
| See examples | Example Use Cases |
| Integrate with tools | Integration Guide |
| Fix problems | Troubleshooting Guide |
| Secure your setup | Security Guide |
By Experience Level
Beginner
- Installation Guide - Start here
- Example Use Cases - See what's possible
- API Documentation - Learn the basics
Intermediate
- Integration Guide - Connect with your tools
- Troubleshooting Guide - Solve common issues
- Security Guide - Secure your implementation
Advanced
- API Documentation - Complete reference
- Security Guide - Advanced security configuration
- Integration Guide - Custom integrations
🆘 Getting Help
Documentation Issues
If you find errors or missing information in the documentation:
- Create a GitHub issue
- Include the specific documentation page and section
Plugin Issues
For plugin bugs or problems:
- Create a GitHub issue
- Include error messages and steps to reproduce
Security Issues
For security vulnerabilities:
- Email: security@devora.no
- Do not create public GitHub issues for security problems
📝 Contributing to Documentation
We welcome contributions to improve the documentation:
- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
Documentation Standards
- Use clear, concise language
- Include code examples where helpful
- Follow the existing format and structure
- Test all code examples before submitting
🔄 Documentation Updates
This documentation is updated with each plugin release. Check the Changelog for the latest changes.
Version Information
- Current Version: 1.0.6
- Last Updated: July 2025
- WordPress Compatibility: 5.0+
- PHP Compatibility: 7.4+
📞 Support
- Documentation: This documentation
- GitHub Issues: Create an issue
- Email Support: devora.no
- Security: security@devora.no
Related Links:
Last Updated: July 2025
Version: 1.0.6