docs: Add comprehensive Wiki.js version compatibility documentation

Add detailed compatibility documentation and version detection:

- Add Wiki.js 2.x compatibility badge and requirements to README
- Create comprehensive docs/compatibility.md guide
  - Detailed version support matrix (2.2 through 2.5.308+)
  - API schema differences between 2.x and 3.x
  - Version detection examples and troubleshooting
  - Known compatibility issues and solutions
  - Future 3.x support planning
- Enhance test_connection() in both sync and async clients
  - Add API version compatibility detection
  - Better error messages for incompatible versions
  - Detect Wiki.js 3.x and provide clear guidance
- Update package metadata
  - Add Wiki.js compatibility keywords to setup.py and pyproject.toml
  - Add compatibility documentation link to project URLs

SDK supports Wiki.js 2.x (versions 2.2 - 2.5.308+)
Wiki.js 3.x (alpha) not yet supported due to different API schema

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude
2025-10-23 20:01:14 +00:00
parent 6fbd24d737
commit 5cd55e65af
6 changed files with 496 additions and 17 deletions

View File

@@ -2,6 +2,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Support](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
[![Wiki.js Support](https://img.shields.io/badge/Wiki.js-2.2+-green.svg)](https://docs.requarks.io/releases)
[![Repository](https://img.shields.io/badge/repo-Gitea-green.svg)](https://gitea.hotserv.cloud/lmiranda/py-wikijs)
[![Issues](https://img.shields.io/badge/issues-Gitea-blue.svg)](https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues)
@@ -50,6 +51,21 @@ new_page = client.pages.create(PageCreate(
---
## 📋 Requirements
### System Requirements
- **Python**: 3.8 or higher
- **Wiki.js**: 2.2 or higher (tested with 2.5.x series)
- **API Access**: Valid API key with appropriate permissions
### Compatibility Notes
> **✅ Supported**: This SDK is designed for **Wiki.js 2.x** (versions 2.2 through 2.5.308+)
> **⚠️ Not Supported**: Wiki.js 3.x (alpha) uses a different API schema and is not yet supported
For detailed compatibility information, see [docs/compatibility.md](docs/compatibility.md).
---
## 🎯 Current Development Status
### **Phase 1: MVP Development** ✅ **COMPLETE**
@@ -76,6 +92,8 @@ new_page = client.pages.create(PageCreate(
### **For Users**
- **[Quick Start](#quick-start)**: Basic setup and usage
- **[Requirements](#requirements)**: System and Wiki.js version requirements
- **[Compatibility Guide](docs/compatibility.md)**: Detailed version compatibility information
- **[API Reference](docs/api_reference.md)**: Complete SDK documentation
- **[User Guide](docs/user_guide.md)**: Comprehensive usage guide with examples
- **[Examples](examples/)**: Real-world usage examples and code samples
@@ -111,9 +129,11 @@ We welcome contributions! This project showcases systematic development with pro
## 🛠️ Development Setup
### Prerequisites
- Python 3.8+
See [Requirements](#requirements) for system and Wiki.js version requirements.
Additional development tools:
- Git
- Wiki.js instance for testing
- Wiki.js 2.x instance for testing (2.2 or higher)
### Local Development
```bash