From 1d1daefb370e5c566be2108eb278371cc36cce5c Mon Sep 17 00:00:00 2001 From: Dwindi Ramadhana Date: Thu, 5 Feb 2026 00:46:35 +0700 Subject: [PATCH] feat: restructure docs into store, marketing, builder, and config sections --- app/page.tsx | 172 +++++++--- contents/docs/builder/index.md | 14 + contents/docs/builder/sections.md | 22 ++ contents/docs/builder/special-pages.md | 17 + contents/docs/builder/visual-editor.md | 26 ++ contents/docs/configuration/appearance.md | 19 ++ contents/docs/configuration/email.md | 17 + contents/docs/configuration/general.md | 18 + contents/docs/configuration/index.md | 16 + contents/docs/configuration/licensing.md | 16 + .../addons/custom-channels/index.mdx | 311 ++++++++++++++++++ .../developer/addons/page-templates/index.mdx | 103 ++++++ contents/docs/getting-started/quick-setup.md | 17 + contents/docs/marketing/coupons.md | 13 + contents/docs/marketing/index.md | 14 + contents/docs/marketing/newsletter.md | 20 ++ contents/docs/marketing/wishlist.md | 13 + contents/docs/store/customers.md | 16 + contents/docs/store/index.md | 14 + contents/docs/store/orders.md | 18 + contents/docs/store/products.md | 17 + docu.json | 160 ++++++--- 22 files changed, 950 insertions(+), 103 deletions(-) create mode 100644 contents/docs/builder/index.md create mode 100644 contents/docs/builder/sections.md create mode 100644 contents/docs/builder/special-pages.md create mode 100644 contents/docs/builder/visual-editor.md create mode 100644 contents/docs/configuration/appearance.md create mode 100644 contents/docs/configuration/email.md create mode 100644 contents/docs/configuration/general.md create mode 100644 contents/docs/configuration/index.md create mode 100644 contents/docs/configuration/licensing.md create mode 100644 contents/docs/developer/addons/custom-channels/index.mdx create mode 100644 contents/docs/developer/addons/page-templates/index.mdx create mode 100644 contents/docs/getting-started/quick-setup.md create mode 100644 contents/docs/marketing/coupons.md create mode 100644 contents/docs/marketing/index.md create mode 100644 contents/docs/marketing/newsletter.md create mode 100644 contents/docs/marketing/wishlist.md create mode 100644 contents/docs/store/customers.md create mode 100644 contents/docs/store/index.md create mode 100644 contents/docs/store/orders.md create mode 100644 contents/docs/store/products.md diff --git a/app/page.tsx b/app/page.tsx index 7049c9f..a75968b 100644 --- a/app/page.tsx +++ b/app/page.tsx @@ -1,21 +1,29 @@ import { buttonVariants } from "@/components/ui/button"; import { page_routes } from "@/lib/routes-config"; -import { ArrowRightIcon, FileJson, GitCommitHorizontal, SquarePlay } from "lucide-react"; +import { + ArrowRightIcon, + LayoutDashboard, + Bell, + Key, + Zap, + Layers, + ShoppingBag +} from "lucide-react"; import Link from "next/link"; import { cn } from "@/lib/utils"; import AnimatedShinyText from "@/components/ui/animated-shiny-text"; import { getMetadata } from "@/app/layout"; -import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card"; +import { Card, CardContent, CardHeader, CardTitle, CardDescription } from "@/components/ui/card"; export const metadata = getMetadata({ - title: "Home", + title: "WooNooW - The Ultimate WooCommerce Enhancement Suite", }); export default function Home() { return ( -
+
@@ -25,71 +33,137 @@ export default function Home() { )} > - 🚀 Release v2.0.0-beta.1 + 🚀 v2.0 Released: Multi-Channel Notifications
-
-

DocuBook Starter Templates

-

- Get started by editing app/page.tsx . Save and see your changes instantly.{' '} - - Read Documentations - + +

+

+ Fill the Gap.
Elevate Your Store. +

+

+ WooNooW bridges the divide between standard WooCommerce and a premium e-commerce experience. + Unified dashboard, SPA performance, and enterprise-grade tools in one suite.

-
+ +
Get Started - Subscribe Now + Explore Features
-
- - - - docu.json - - -

Edit the docu.json file to change the content in the header, footer and sidebar.

- - - - - - CHANGELOG.md - - -

Manage changes to each version of your application in the CHANGELOG.md file.

- - - - - - Docu Play - - -

Easy to write interactive markdown content with a playground.

- - + + {/* The Gap Analysis */} +
+
+ {/* Production Reality (The Problem) */} +
+

+ + Standard WooCommerce +

+
    +
  • + ✕ Disjointed UX using multiple plugins +
    • +
  • + ✕ Slow standard page loads (MPA) +
    • +
  • + ✕ Basic, rigid email notifications +
    • +
  • + ✕ Complex license management via 3rd parties +
    • +
+
+ + {/* The WooNooW Solution */} +
+

+ + With WooNooW +

+
    +
  • + ✓ Unified SPA Dashboard for customers +
    • +
  • + ✓ Multi-Channel (WhatsApp, SMS, Email) +
    • +
  • + ✓ Built-in Licensing & OAuth Server +
    • +
  • + ✓ Modular Architecture with Bridge Pattern +
    • +
+
+
+
+ +
+

Core Modules

+
+ + + + Customer SPA + + React-based frontend that replaces standard My Account pages with a lightning-fast interface. + + + + + + + + Notification Engine + + Advanced template engine supporting Email, SMS, WhatsApp, and Telegram out of the box. + + + + + + + + License Manager + + Complete OAuth2 server implementation for managing software licenses and updates. + + + + + + + + Developer Friendly + + Extend functionality using our Bridge Pattern and Module Registry APIs. + + + +
); diff --git a/contents/docs/builder/index.md b/contents/docs/builder/index.md new file mode 100644 index 0000000..77b9aa3 --- /dev/null +++ b/contents/docs/builder/index.md @@ -0,0 +1,14 @@ +--- +title: Page Builder +description: Design your store visually. +--- + +# Page Builder + +The WooNooW Page Builder allows you to create stunning, responsive pages without writing code. + +## Key Concepts + +* **[Visual Editor](/docs/builder/visual-editor)**: Drag-and-drop interface explanation. +* **[Sections](/docs/builder/sections)**: Guide to all available blocks (Hero, Features, Content). +* **[Special Pages](/docs/builder/special-pages)**: How to customize the Shop, Cart, and Checkout pages. diff --git a/contents/docs/builder/sections.md b/contents/docs/builder/sections.md new file mode 100644 index 0000000..c3087ed --- /dev/null +++ b/contents/docs/builder/sections.md @@ -0,0 +1,22 @@ +--- +title: Section Components +description: Building blocks of your pages. +--- + +# Section Components + +WooNooW includes a library of pre-designed sections. + +## Available Sections + +### Hero Section +The impact statement of your page. Includes a large headline, subheadline, call-to-action buttons, and a background image or color. + +### Feature Grid +Showcase your services or product highlights in a clean grid layout. Supports 2, 3, or 4 columns. + +### Content Block +A versatile text block with optional image. Great for "About Us" sections or storytelling. You can position the image on the left or right. + +### Call to Action (CTA) Banner +A high-converting strip designed to get clicks. Perfect for newsletter signups or limited-time offers. diff --git a/contents/docs/builder/special-pages.md b/contents/docs/builder/special-pages.md new file mode 100644 index 0000000..a52cf50 --- /dev/null +++ b/contents/docs/builder/special-pages.md @@ -0,0 +1,17 @@ +--- +title: Special Pages +description: Customizing Shop and Checkout pages. +--- + +# Special Pages + +Unlike standard pages, "Special Pages" like the Shop, Cart, and Checkout are dynamically generated by WooCommerce. WooNooW gives you control over their wrapper and styling. + +## The Shop Page +You can set a specific page to be your "Shop" page in **WooCommerce > Settings > Products**. +Once set, WooNooW wraps this product grid in your global theme settings (Header, Footer, Container Width). + +## Cart & Checkout +By enabling **SPA Mode** (Full or Checkout Only), WooNooW replaces the standard slow page loads with an instant, app-like transition. +* **Checkout Only Mode**: Users browse your normal site, but when they hit "Checkout", they enter the fast SPA data tunnel. +* **Full SPA Mode**: The entire shopping experience is instant. diff --git a/contents/docs/builder/visual-editor.md b/contents/docs/builder/visual-editor.md new file mode 100644 index 0000000..273f211 --- /dev/null +++ b/contents/docs/builder/visual-editor.md @@ -0,0 +1,26 @@ +--- +title: Visual Editor +description: Drag-and-drop your store into existence. +--- + +# Visual Editor + +The Visual Editor is the heart of the WooNooW Page Builder. It looks exactly like your front-end store, but allows you to edit content in real-time. + +## The Interface + +### 1. The Canvas +The central area is your webpage. You can click on any element (Text, Image, Button) to edit it directly. + +### 2. The Inspector Panel (Left Sidebar) +When you select a section or element, this panel shows all customizable options: +* **Content Tab**: Change text, links, and images. +* **Design Tab**: Adjust colors, padding, and alignment. + +### 3. The Top Bar +* **Device Toggle**: Switch between Desktop and Mobile view to ensure your site looks great everywhere. +* **Save Button**: Publish your changes instantly. + +## Adding Content + +To add a new section, hover over the canvas and click the **(+) Add Section** button that appears between existing blocks. diff --git a/contents/docs/configuration/appearance.md b/contents/docs/configuration/appearance.md new file mode 100644 index 0000000..7e523de --- /dev/null +++ b/contents/docs/configuration/appearance.md @@ -0,0 +1,19 @@ +--- +title: Appearance Settings +description: Colors and Typography. +--- + +# Appearance + +Customize your brand without coding. + +## Colors +We use a smart palette system. +* **Primary**: Headlines and main buttons. +* **Secondary**: Subheadings and UI elements. +* **Accent**: Highlights and links. + +## Typography +Choose from GDPR-compliant, locally hosted font pairings like: +* **Modern**: Inter +* **Editorial**: Playfair Display diff --git a/contents/docs/configuration/email.md b/contents/docs/configuration/email.md new file mode 100644 index 0000000..14884c1 --- /dev/null +++ b/contents/docs/configuration/email.md @@ -0,0 +1,17 @@ +--- +title: Email Settings +description: Transactional emails and SMTP. +--- + +# Email Settings + +WooNooW replaces default WooCommerce emails with beautiful, responsive templates. + +## Template Editor +Go to **Settings > Email** to customize: +* **Order Confirmation** +* **Shipping Updates** +* **Account Notifications** + +## SMTP Configuration +Ensure your emails hit the inbox, not spam. We recommend using a dedicated SMTP service like SendGrid or Postmark. diff --git a/contents/docs/configuration/general.md b/contents/docs/configuration/general.md new file mode 100644 index 0000000..d136c19 --- /dev/null +++ b/contents/docs/configuration/general.md @@ -0,0 +1,18 @@ +--- +title: General Settings +description: Core store settings. +--- + +# General Settings + +Located in **Appearance > General**. + +## SPA Mode +Decide how much of your site uses our ultra-fast Single Page Application technology. +* **Disabled**: Use standard WordPress templates. +* **Checkout Only**: Normal browsing, fast checkout. +* **Full SPA**: The entire site is an app. + +## Container Width +* **Boxed (Recommended)**: Limits content width (max 1152px) for better readability. +* **Full Width**: Content stretches to the screen edges. diff --git a/contents/docs/configuration/index.md b/contents/docs/configuration/index.md new file mode 100644 index 0000000..fe773ea --- /dev/null +++ b/contents/docs/configuration/index.md @@ -0,0 +1,16 @@ +--- +title: Configuration +description: Configure every aspect of your store. +--- + +# Configuration + +Fine-tune your store's behavior and appearance. + +## Settings Areas + +* **[General](/docs/configuration/general)**: SPA Mode, Container Width, Typography. +* **[Appearance](/docs/configuration/appearance)**: Theme colors and branding. +* **[Modules](/docs/configuration/modules)**: Enable or disable specific features to keep your store lightweight. +* **[Email](/docs/configuration/email)**: Customize transactional emails and set up SMTP. +* **[Security](/docs/configuration/security)**: Protect your store with built-in security features. diff --git a/contents/docs/configuration/licensing.md b/contents/docs/configuration/licensing.md new file mode 100644 index 0000000..040a227 --- /dev/null +++ b/contents/docs/configuration/licensing.md @@ -0,0 +1,16 @@ +--- +title: Licensing +description: Activate your store. +--- + +# Licensing + +To receive updates and support, you must activate your license key. + +## Activation +1. Go to **Settings > License**. +2. Enter your key. +3. Click "Activate". + +## OAuth Connection +Some features require connecting your store to our cloud. Click "Connect with WooNooW" to authorize the connection securely. diff --git a/contents/docs/developer/addons/custom-channels/index.mdx b/contents/docs/developer/addons/custom-channels/index.mdx new file mode 100644 index 0000000..861e451 --- /dev/null +++ b/contents/docs/developer/addons/custom-channels/index.mdx @@ -0,0 +1,311 @@ +--- +title: Custom Notification Channels +description: Learn how to add custom notification channels like WhatsApp, SMS, or Telegram to WooNooW +--- + +# Custom Notification Channels + +WooNooW supports custom notification channels through a pluggable architecture. You can extend the notification system to send messages via WhatsApp, SMS, Telegram, or any other service. + +## Architecture Overview + +The multi-channel notification system consists of three core components: + +1. **`ChannelInterface`** - Contract that all channels must implement +2. **`ChannelRegistry`** - Central registry for managing channels +3. **`NotificationManager`** - Sends notifications through registered channels + +```mermaid +graph LR + A[NotificationManager] --> B[ChannelRegistry] + B --> C[Email Channel] + B --> D[WhatsApp Channel] + B --> E[SMS Channel] + B --> F[Custom Channel] +``` + +## Creating a Custom Channel + +### Step 1: Implement ChannelInterface + +Create a class that implements `WooNooW\Core\Notifications\Channels\ChannelInterface`: + +```php + true, + 'message' => 'Sent successfully' + ]; + } + + public function get_config_fields() { + return [ + [ + 'id' => 'my_whatsapp_api_key', + 'label' => 'API Key', + 'type' => 'text', + ], + ]; + } +} +``` + +### Step 2: Register Your Channel + +Register your channel with the `ChannelRegistry` during plugin initialization: + +```php +use WooNooW\Core\Notifications\ChannelRegistry; +use MyPlugin\Channels\WhatsAppChannel; + +add_action('init', function() { + $channel = new WhatsAppChannel(); + ChannelRegistry::register($channel); +}); +``` + +### Step 3: Enable in Settings + +Once registered, your channel will be available in the notification settings UI, where users can configure which events should use WhatsApp. + +## Interface Reference + +### get_id() + +Returns a unique identifier for your channel. + +```php +public function get_id(): string +``` + +**Example:** +```php +public function get_id() { + return 'whatsapp'; // or 'sms', 'telegram', etc. +} +``` + +### get_label() + +Returns a human-readable label for the admin UI. + +```php +public function get_label(): string +``` + +**Example:** +```php +public function get_label() { + return __('WhatsApp Business', 'my-plugin'); +} +``` + +### is_configured() + +Checks if the channel has all required configuration (API keys, credentials, etc.). + +```php +public function is_configured(): bool +``` + +**Example:** +```php +public function is_configured() { + $api_key = get_option('my_whatsapp_api_key'); + $phone = get_option('my_whatsapp_phone'); + return !empty($api_key) && !empty($phone); +} +``` + +### send() + +Sends a notification through this channel. + +```php +public function send(string $event_id, string $recipient, array $data): bool|array +``` + +**Parameters:** +- `$event_id` - Event identifier (e.g., `'order_completed'`, `'newsletter_confirm'`) +- `$recipient` - Recipient type (`'customer'` or `'staff'`) +- `$data` - Context data including order, user, custom variables + +**Returns:** +- `bool` - Simple success/failure +- `array` - Detailed result with `success` and `message` keys + +**Example:** +```php +public function send($event_id, $recipient, $data) { + $phone = $this->get_recipient_phone($recipient, $data); + $message = $this->build_message($event_id, $data); + + $response = wp_remote_post('https://api.provider.com/send', [ + 'body' => [ + 'to' => $phone, + 'message' => $message, + 'api_key' => get_option('my_api_key'), + ], + ]); + + if (is_wp_error($response)) { + return [ + 'success' => false, + 'message' => $response->get_error_message(), + ]; + } + + return ['success' => true]; +} +``` + +### get_config_fields() + +Returns configuration fields for the admin settings UI (optional). + +```php +public function get_config_fields(): array +``` + +**Field Structure:** +```php +[ + 'id' => 'option_name', + 'label' => 'Field Label', + 'type' => 'text|select|textarea', + 'description' => 'Help text', + 'options' => [], // For select fields + 'default' => 'value', +] +``` + +## Complete Example: WhatsApp Channel + +See the reference implementation: +[WhatsAppChannel.example.php](file:///Users/dwindown/Local%20Sites/woonoow/app/public/wp-content/plugins/woonoow/includes/Core/Notifications/Channels/WhatsAppChannel.example.php) + +This example includes: +- ✅ Twilio API integration +- ✅ Phone number extraction from orders/users +- ✅ Message templates for common events +- ✅ Configuration fields for admin settings + +## Message Customization + +Use filters to customize messages for specific events: + +```php +add_filter('woonoow_whatsapp_message_order_completed', function($message, $data) { + if (isset($data['order'])) { + $order = $data['order']; + return sprintf( + "🎉 Order #%s confirmed! Track here: %s", + $order->get_order_number(), + $order->get_view_order_url() + ); + } + return $message; +}, 10, 2); +``` + +## Available Events + +Your channel can handle any registered notification event: + +| Event | Recipient | Data Available | +|-------|-----------|----------------| +| `order_completed` | customer | `order`, `user_id` | +| `order_cancelled` | customer | `order`, `user_id` | +| `newsletter_confirm` | customer | `email`, `confirmation_url` | +| `newsletter_welcome` | customer | `email`, `user_id` | +| `subscription_expiring` | customer | `subscription`, `user_id` | + +See [Event Registry](/hooks/notifications#event-registry) for the complete list. + +## Testing Your Channel + +```php +// Manual test +use WooNooW\Core\Notifications\NotificationManager; + +NotificationManager::send('order_completed', 'whatsapp', [ + 'order' => wc_get_order(123), + 'user_id' => 1, +]); +``` + +## Best Practices + +1. **Validate Configuration**: Always check `is_configured()` before attempting to send +2. **Handle Errors Gracefully**: Return detailed error messages for debugging +3. **Log Send Attempts**: Use `do_action()` for tracking/analytics +4. **Support Filtering**: Allow message customization via filters +5. **Rate Limiting**: Consider implementing rate limiting for API calls + +## Hooks + +### Registration Hook +```php +// Register channels during init +add_action('init', function() { + ChannelRegistry::register(new MyChannel()); +}); +``` + +### Custom Hooks in Your Channel +```php +// Allow logging/tracking +do_action('my_channel_sent', $event_id, $recipient, $result); + +// Allow message customization +$message = apply_filters( + "my_channel_message_{$event_id}", + $default_message, + $data +); +``` + +## Troubleshooting + +**Channel not appearing in settings?** +- Ensure `ChannelRegistry::register()` is called during `init` +- Check that `get_id()` returns a unique string +- Verify `is_configured()` returns `true` + +**Messages not sending?** +- Check notification settings: Marketing > Notifications +- Verify the event has your channel enabled +- Enable debug mode and check logs +- Test `is_configured()` returns true + +**API errors?** +- Validate API credentials in settings +- Check API provider status/quotas +- Review error logs for API responses + +## Related Documentation + +- [Notification System](/core-concepts/notifications) +- [Event Registry](/hooks/notifications#event-registry) +- [Notification Hooks](/hooks/notifications) diff --git a/contents/docs/developer/addons/page-templates/index.mdx b/contents/docs/developer/addons/page-templates/index.mdx new file mode 100644 index 0000000..58bd57e --- /dev/null +++ b/contents/docs/developer/addons/page-templates/index.mdx @@ -0,0 +1,103 @@ +--- +title: Custom Page Templates +description: Learn how to register custom starting templates for the Page Editor. +--- + +WooNooW allows developers to register custom page templates. These templates appear in the "Create New Page" modal, allowing users to start with a pre-configured layout instead of a blank page. + +## Registering a Template + +To add a new template, use the `woonoow_page_templates` filter. You should append your template definition to the existing array. + +```php +add_filter('woonoow_page_templates', function($templates) { + $templates[] = [ + 'id' => 'my-custom-landing', + 'label' => 'Product Launch', + 'description' => 'A structured page for new product announcements.', + 'icon' => 'rocket', // Lucide icon name (lowercase) + 'sections' => [ + // Section definitions... + ] + ]; + return $templates; +}); +``` + +## Template Structure + +Each template requires the following properties: + +| Property | Type | Description | +| :--- | :--- | :--- | +| `id` | string | Unique identifier for the template. | +| `label` | string | Display name shown in the modal. | +| `description` | string | Short description of the template's purpose. | +| `icon` | string | Name of a Lucide icon (e.g., `layout`, `users`, `rocket`). | +| `sections` | array | Array of section objects defining the initial layout. | + +### Defining Sections + +Sections are the building blocks of a page. Each section object mimics the structure stored in the database. + +```php +[ + 'id' => uniqid('section_'), // Must be unique + 'type' => 'hero', // Component type (hero, feature-grid, image-text, etc.) + 'props' => [ + 'title' => ['type' => 'static', 'value' => 'Hello World'], + 'subtitle' => ['type' => 'static', 'value' => 'This is a template.'], + ], + 'styles' => [ + 'contentWidth' => 'contained', // 'full' or 'contained' + 'padding' => 'medium', + ] +] +``` + +## Example: Full Configuration + +Here is a complete example that registers a "Support Page" template with a Hero and a FAQ section. + +```php +add_filter('woonoow_page_templates', function($templates) { + $templates[] = [ + 'id' => 'support-page', + 'label' => 'Support Center', + 'description' => 'Help desk layout with search and FAQ grid.', + 'icon' => 'help-circle', + 'sections' => [ + // Hero Section + [ + 'id' => uniqid('section_'), + 'type' => 'hero', + 'props' => [ + 'title' => ['type' => 'static', 'value' => 'How can we help?'], + 'cta_text' => ['type' => 'static', 'value' => 'Contact Support'], + 'cta_url' => ['type' => 'static', 'value' => '/contact'], + ], + 'styles' => ['contentWidth' => 'full'] + ], + // Content Section + [ + 'id' => uniqid('section_'), + 'type' => 'content', + 'props' => [ + 'content' => ['type' => 'static', 'value' => '

Frequently Asked Questions

Find answers below.

'] + ], + 'styles' => ['contentWidth' => 'contained'] + ] + ] + ]; + return $templates; +}); +``` + +## Available Section Types + +Common available section types include: +- `hero`: Large banner with title, subtitle, and CTA. +- `content`: Rich text editor content. +- `image-text`: Split layout with image and text. +- `feature-grid`: Grid of icons and text. +- `cta-banner`: Call to action strip. diff --git a/contents/docs/getting-started/quick-setup.md b/contents/docs/getting-started/quick-setup.md new file mode 100644 index 0000000..02538d2 --- /dev/null +++ b/contents/docs/getting-started/quick-setup.md @@ -0,0 +1,17 @@ +--- +title: Quick Setup Wizard +description: Get your store running in minutes. +--- + +# Quick Setup Wizard + +The Quick Setup Wizard is the fastest way to configure your WooNooW store. It launches automatically when you first activate the plugin. + +## Steps + +1. **Choose Your Mode**: Select between **Full SPA** (best for new stores) or **Checkout Only** (best for existing themes). +2. **Homepage Setup**: Automatically create a "Shop" page and set it as your home. +3. **Design**: Choose a "Boxed" or "Full Width" layout and pick a color theme. +4. **Launch**: Be redirected immediately to the Visual Builder. + +If you skipped the wizard, you can always configure these options manually in **Appearance > General**. diff --git a/contents/docs/marketing/coupons.md b/contents/docs/marketing/coupons.md new file mode 100644 index 0000000..2ee6432 --- /dev/null +++ b/contents/docs/marketing/coupons.md @@ -0,0 +1,13 @@ +--- +title: Coupons +description: Smart discounts and promotions. +--- + +# Coupons + +Go beyond standard WooCommerce coupons. + +## Smart Features +* **Auto-Apply**: Apply coupons automatically when cart conditions are met. +* **Bulk Generation**: Generate thousands of unique codes for partners. +* **URL Coupons**: Create links that automatically apply a discount when clicked. diff --git a/contents/docs/marketing/index.md b/contents/docs/marketing/index.md new file mode 100644 index 0000000..b544d21 --- /dev/null +++ b/contents/docs/marketing/index.md @@ -0,0 +1,14 @@ +--- +title: Marketing Suite +description: Grow your business with built-in tools. +--- + +# Marketing Suite + +WooNooW comes with a powerful suite of marketing tools to help you retain customers and increase sales. + +## Features + +* **[Newsletter](/docs/marketing/newsletter)**: Create campaigns and manage subscribers directly from your dashboard. +* **[Coupons](/docs/marketing/coupons)**: Create smart coupons and automatic discounts. +* **[Wishlist](/docs/marketing/wishlist)**: Let customers save their favorite items for later. diff --git a/contents/docs/marketing/newsletter.md b/contents/docs/marketing/newsletter.md new file mode 100644 index 0000000..f173aa9 --- /dev/null +++ b/contents/docs/marketing/newsletter.md @@ -0,0 +1,20 @@ +--- +title: Newsletter +description: Manage subscribers and campaigns. +--- + +# Newsletter + +A complete email marketing solution built into your store. + +## Subscribers +Automatically capture emails at checkout or via the footer form. +* **GDPR**: Includes double opt-in support. +* **Segmentation**: Tag subscribers based on purchase history. + +## Campaigns +Send beautiful HTML emails to your list. +1. Go to **Marketing > Newsletter**. +2. Click **New Campaign**. +3. Use the Template Builder to design your email. +4. Schedule or send immediately. diff --git a/contents/docs/marketing/wishlist.md b/contents/docs/marketing/wishlist.md new file mode 100644 index 0000000..c9e037a --- /dev/null +++ b/contents/docs/marketing/wishlist.md @@ -0,0 +1,13 @@ +--- +title: Wishlist +description: Let customers save products. +--- + +# Wishlist + +Enable the heart icon on your products. + +## How it works +* **Guest Support**: Guests can save items (stored in cookies/local storage). +* **Account Sync**: When guests log in, their wishlist is saved to their account. +* **Sharing**: Customers can share their wishlist via social media or email. diff --git a/contents/docs/store/customers.md b/contents/docs/store/customers.md new file mode 100644 index 0000000..a0d1e1a --- /dev/null +++ b/contents/docs/store/customers.md @@ -0,0 +1,16 @@ +--- +title: Customers +description: VIP classification and metrics. +--- + +# Customer Management + +Know who buys from you. + +## VIP Classification +WooNooW automatically tags customers based on their spend. +* **VIP**: High spenders. +* **Regular**: Frequent buyers. +* **New**: First-time buyers. + +You can use these tags to segment your [Newsletter](/docs/marketing/newsletter) campaigns. diff --git a/contents/docs/store/index.md b/contents/docs/store/index.md new file mode 100644 index 0000000..100a9d5 --- /dev/null +++ b/contents/docs/store/index.md @@ -0,0 +1,14 @@ +--- +title: Store Management +description: Manage your daily operations. +--- + +# Store Management + +The Store Management section allows you to handle day-to-day operations efficiently. + +## Sections + +* **[Orders](/docs/store/orders)**: View and process customer orders with a modern interface. +* **[My Customers](/docs/store/customers)**: Manage your customer base and assign VIP statuses. +* **[Products](/docs/store/products)**: Quick overview and management of your catalog. diff --git a/contents/docs/store/orders.md b/contents/docs/store/orders.md new file mode 100644 index 0000000..062becf --- /dev/null +++ b/contents/docs/store/orders.md @@ -0,0 +1,18 @@ +--- +title: Orders +description: Processing transactions. +--- + +# Order Management + +View and manage orders in **Store Management > Orders**. + +## The Order Table +A modern, real-time view of your sales. +* **Status Filters**: Quickly see what needs processing. +* **Quick Actions**: Print invoices or mark as shipped directly from the list. + +## Order Details +Clicking an order reveals the deep dive view: +* **Timeline**: See exactly when payment happened and emails were sent. +* **Edit Items**: Modify the order contents before fulfillment. diff --git a/contents/docs/store/products.md b/contents/docs/store/products.md new file mode 100644 index 0000000..248d9af --- /dev/null +++ b/contents/docs/store/products.md @@ -0,0 +1,17 @@ +--- +title: Products +description: Managing your catalog. +--- + +# Products + +WooNooW enhances the standard WooCommerce product management. + +## Quick Edit +Update prices and stock levels directly from the list view without opening each product. + +## Types +We support all standard types: +* **Simple Product** +* **Variable Product** +* **Digital/Downloadable** diff --git a/docu.json b/docu.json index fe0ad3f..90ab290 100644 --- a/docu.json +++ b/docu.json @@ -19,7 +19,7 @@ }, { "title": "Developer Docs", - "href": "/docs" + "href": "/developer" }, { "title": "Plugin Site", @@ -53,7 +53,7 @@ "context": { "icon": "Book", "description": "Guides and References", - "title": "Docs" + "title": "Start" }, "items": [ { @@ -63,6 +63,82 @@ { "title": "Installation", "href": "/installation" + }, + { + "title": "Quick Setup Wizard", + "href": "/quick-setup" + } + ] + }, + { + "title": "Store Management", + "href": "/store", + "noLink": true, + "context": { + "icon": "ShoppingBag", + "description": "Orders, Customers, Products", + "title": "Store" + }, + "items": [ + { + "title": "Orders", + "href": "/orders" + }, + { + "title": "My Customers (VIP)", + "href": "/customers" + }, + { + "title": "Products", + "href": "/products" + } + ] + }, + { + "title": "Marketing Suite", + "href": "/marketing", + "noLink": true, + "context": { + "icon": "Megaphone", + "description": "Campaigns & Growth", + "title": "Marketing" + }, + "items": [ + { + "title": "Newsletter", + "href": "/newsletter" + }, + { + "title": "Coupons", + "href": "/coupons" + }, + { + "title": "Wishlist", + "href": "/wishlist" + } + ] + }, + { + "title": "Page Builder", + "href": "/builder", + "noLink": true, + "context": { + "icon": "Layout", + "description": "Visual Editor & Design", + "title": "Builder" + }, + "items": [ + { + "title": "Visual Editor", + "href": "/visual-editor" + }, + { + "title": "Section Components", + "href": "/sections" + }, + { + "title": "Special Pages (Shop/Cart)", + "href": "/special-pages" } ] }, @@ -77,67 +153,31 @@ }, "items": [ { - "title": "SPA Mode", - "href": "/spa-mode" + "title": "General Settings", + "href": "/general" }, { - "title": "Appearance", + "title": "Appearance (Colors/Type)", "href": "/appearance" - } - ] - }, - { - "title": "Core Features", - "href": "/features", - "noLink": true, - "context": { - "icon": "Layout", - "description": "Store Functionality", - "title": "Features" - }, - "items": [ - { - "title": "Shop Page", - "href": "/shop" }, { - "title": "Checkout", - "href": "/checkout" + "title": "Modules", + "href": "/modules" }, { - "title": "Shortcodes", - "href": "/shortcodes" - } - ] - }, - { - "title": "Licensing & OAuth", - "href": "/licensing", - "noLink": true, - "context": { - "icon": "Key", - "description": "License Management", - "title": "Licensing" - }, - "items": [ + "title": "Email Settings", + "href": "/email" + }, { - "title": "OAuth Flow", - "href": "/oauth-flow" - } - ] - }, - { - "title": "API Reference", - "href": "/api-reference", - "noLink": true, - "context": { - "icon": "Terminal", - "description": "API Endpoints", - "title": "API" - }, - "items": [ + "title": "Security", + "href": "/security" + }, { - "title": "Licensing API", + "title": "Payment & Shipping", + "href": "/payment-shipping" + }, + { + "title": "Licensing", "href": "/licensing" } ] @@ -152,6 +192,14 @@ "title": "Dev" }, "items": [ + { + "title": "Custom Channels", + "href": "/addons/custom-channels" + }, + { + "title": "Page Templates", + "href": "/addons/page-templates" + }, { "title": "Addons: Bridge Pattern", "href": "/addons/bridge-pattern" @@ -163,6 +211,10 @@ { "title": "Addons: Module Registry", "href": "/addons/module-integration" + }, + { + "title": "Licensing API", + "href": "/api/licensing" } ] },