Files

Dwindi Ramadhana 68c3423f50 feat: Add in-app documentation system

Phase 1: Core Documentation
- Created docs/ folder with 8 markdown documentation files
- Getting Started, Installation, Troubleshooting, FAQ
- Configuration docs (Appearance, SPA Mode)
- Feature docs (Shop, Checkout)
- PHP registry with filter hook for addon extensibility

Phase 2: Documentation Viewer
- DocsController.php with REST API endpoints
- GET /woonoow/v1/docs - List all docs (with addon hook)
- GET /woonoow/v1/docs/{slug} - Get document content
- Admin SPA /help route with sidebar navigation
- Markdown rendering with react-markdown
- Added Help & Docs to More page for mobile access

Filter Hook: woonoow_docs_registry
Addons can register their own documentation sections.

2026-01-04 11:43:32 +07:00

2.5 KiB

Raw Blame History

Installation Guide

This guide covers installing WooNooW on your WordPress site.

Requirements

Before installing, ensure your site meets these requirements:

Requirement	Minimum	Recommended
WordPress	6.0+	Latest
WooCommerce	7.0+	Latest
PHP	7.4+	8.1+
MySQL	5.7+	8.0+

Installation Methods

Method 1: WordPress Admin (Recommended)

Go to Plugins → Add New
Click Upload Plugin
Select the woonoow.zip file
Click Install Now
Click Activate

Method 2: FTP Upload

Extract woonoow.zip to get the woonoow folder
Upload to /wp-content/plugins/
Go to Plugins → Installed Plugins
Find WooNooW and click Activate

Post-Installation

After activation, WooNooW automatically:

1. Creates Store Page

A new "Store" page is created with the SPA shortcode. This is your main storefront.

2. Registers Rewrite Rules

URL routes like /store/shop and /store/product/... are registered.

Note

: If you see 404 errors, go to Settings → Permalinks and click Save Changes to flush rewrite rules.

3. Sets Default Configuration

Basic appearance settings are configured with sensible defaults.

Verification Checklist

After installation, verify everything works:

Plugin activated without errors
WooNooW menu appears in admin sidebar
Store page exists (check Pages)
/store URL loads the SPA
Products display on shop page

WooCommerce Compatibility

WooNooW works alongside WooCommerce:

WooCommerce Page	WooNooW Behavior (Full Mode)
`/shop`	Redirects to `/store/shop`
`/product/...`	Redirects to `/store/product/...`
`/cart`	Redirects to `/store/cart`
`/checkout`	Redirects to `/store/checkout`
`/my-account`	Redirects to `/store/my-account`

When SPA Mode is Disabled, WooCommerce pages work normally.

Updating

To update WooNooW:

Download the latest version
Go to Plugins → Installed Plugins
Deactivate WooNooW (optional but recommended)
Delete the old version
Install and activate the new version

Your settings are preserved in the database.

Uninstalling

To completely remove WooNooW:

Deactivate the plugin (restores WooCommerce page content)
Delete the plugin
(Optional) Delete WooNooW options from database

Note

: Deactivating restores original WooCommerce shortcodes to Cart, Checkout, and My Account pages.

2.5 KiB Raw Blame History