Installation
Requirements
- WordPress 6.0 or higher
- PHP 8.0 or higher
- Chubes theme (required for full functionality)
- Composer (for dependency management)
Installation
(Developer note: this repo’s installation process varies by environment; this page avoids step-by-step setup details.)
Installation Steps
- Install the Chubes theme – This plugin requires the Chubes theme to be active for documentation features
- Download the plugin ZIP file from the releases page
- In WordPress admin, go to Plugins > Add New
- Click "Upload Plugin"
- Upload the
chubes-docs.zipfile - Activate the plugin
Development Setup
For development:
- Clone the repository
- Run
composer installto install PHP dependencies - Run
./build.shto create production build
Features
- Documentation Management: Custom
documentationpost type with Gutenberg editor support - Project Taxonomy: Hierarchical
projecttaxonomy for organizing documentation by project - REST API Layer: Complete CRUD operations for docs, project management, and sync operations
- Markdown Processing: Convert markdown to HTML with internal link resolution using Parsedown
- Sync System: External documentation synchronization with batch operations and project setup
- Repository Integration: GitHub and WordPress.org repository metadata tracking
- Install Tracking: Automatic fetching of active install counts from WordPress.org API
- Template Enhancements: Archive views, project cards, related posts, and breadcrumb navigation
Post-Installation
After activation, the plugin will:
- Register the
documentationpost type - Create the
projecttaxonomy - Set up REST API routes
- Initialize install tracking