refactor: Migrate documentation content, rebuild UI components, and update core architecture.
This commit is contained in:
gitfromwildan
94
docs/getting-started/installation.mdx
Normal file
94
docs/getting-started/installation.mdx
Normal file
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: Installation Guide
|
||||
description: Installing WooNooW on your WordPress site
|
||||
date: 2024-01-31
|
||||
---
|
||||
|
||||
## 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)
|
||||
|
||||
1. Go to **Plugins → Add New**
|
||||
2. Click **Upload Plugin**
|
||||
3. Select the `woonoow.zip` file
|
||||
4. Click **Install Now**
|
||||
5. Click **Activate**
|
||||
|
||||
### Method 2: FTP Upload
|
||||
|
||||
1. Extract `woonoow.zip` to get the `woonoow` folder
|
||||
2. Upload to `/wp-content/plugins/`
|
||||
3. Go to **Plugins → Installed Plugins**
|
||||
4. 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:
|
||||
|
||||
1. Download the latest version
|
||||
2. Go to **Plugins → Installed Plugins**
|
||||
3. Deactivate WooNooW (optional but recommended)
|
||||
4. Delete the old version
|
||||
5. Install and activate the new version
|
||||
|
||||
Your settings are preserved in the database.
|
||||
|
||||
## Uninstalling
|
||||
|
||||
To completely remove WooNooW:
|
||||
|
||||
1. Deactivate the plugin (restores WooCommerce page content)
|
||||
2. Delete the plugin
|
||||
3. (Optional) Delete WooNooW options from database
|
||||
|
||||
> **Note**: Deactivating restores original WooCommerce shortcodes to Cart, Checkout, and My Account pages.
|
||||
39
docs/getting-started/introduction.mdx
Normal file
39
docs/getting-started/introduction.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Introduction
|
||||
description: Overview of the WooNooW Plugin ecosystem
|
||||
date: 2024-01-31
|
||||
---
|
||||
|
||||
## What is WooNooW?
|
||||
|
||||
**WooNooW** is a comprehensive WooCommerce enhancement suite designed to power up your online store. It provides a robust set of tools for license management, subscription handling, and custom checkout flows.
|
||||
|
||||
### Key Features
|
||||
|
||||
* **License Management**: Sell and manage digital software licenses with ease.
|
||||
* **OAuth Activation**: Secure, user-verified license activation flow.
|
||||
* **Subscription Utilities**: Enhanced subscription notifications and manual renewal controls.
|
||||
* **Developer API**: Full REST API for extending functionality.
|
||||
|
||||
---
|
||||
|
||||
## Why use WooNooW?
|
||||
|
||||
If you are a plugin developer or a digital store owner using WooCommerce, WooNooW simplifies the complex parts of your business logic.
|
||||
|
||||
<CardGroup>
|
||||
<Card title="For Developers" icon="Terminal">
|
||||
Built with extensibility in mind. Use our hooks, filters, and REST API to build custom integrations.
|
||||
</Card>
|
||||
<Card title="For Store Owners" icon="Box">
|
||||
Manage your digital products, verified customers, and subscriptions all in one place.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Getting Help
|
||||
|
||||
Need assistance? Check out our support channels:
|
||||
|
||||
* [Official Support](https://woonoow.com/support)
|
||||
* [Community Forums](https://community.woonoow.com)
|
||||
* [Developer Docs](https://docs.woonoow.com)
|
||||
17
docs/getting-started/quick-setup.mdx
Normal file
17
docs/getting-started/quick-setup.mdx
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Quick Setup Wizard
|
||||
description: Get your store running in minutes.
|
||||
---
|
||||
|
||||
|
||||
|
||||
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**.
|
||||
63
docs/getting-started/quick-start-guide.mdx
Normal file
63
docs/getting-started/quick-start-guide.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title : Quick Start Guide
|
||||
description : a quick way to understand how to use it
|
||||
date : 10-12-2024
|
||||
---
|
||||
|
||||
## Heading 2
|
||||
|
||||
this is regular text written in markdown format with `inline code`, **bold**, and *italic*
|
||||
|
||||
### Heading 3
|
||||
|
||||
example of ordered list format :
|
||||
|
||||
- list one
|
||||
- sub list
|
||||
- list two
|
||||
- list three
|
||||
|
||||
#### Heading 4
|
||||
|
||||
Below is an example of how to write a code block :
|
||||
|
||||
````plaintext
|
||||
```javascript:main.js showLineNumbers {3-4}
|
||||
function isRocketAboutToCrash() {
|
||||
// Check if the rocket is stable
|
||||
if (!isStable()) {
|
||||
NoCrash(); // Prevent the crash
|
||||
}
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
example note :
|
||||
```plaintext
|
||||
<Note type="note" title="Note">
|
||||
This is a general note to convey information to the user.
|
||||
</Note>
|
||||
```
|
||||
|
||||
displaying an image in markdown format :
|
||||
|
||||
```plaintext
|
||||
|
||||
```
|
||||
|
||||
render as :
|
||||
|
||||
|
||||
For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
|
||||
|
||||
<Note type="warning" title="Warning">
|
||||
every page that is indexed in a folder will have an `index.mdx` file with metadata :
|
||||
```plaintext
|
||||
---
|
||||
title : Introduction
|
||||
description : overview or synopsis of a project
|
||||
date : 10-12-2024
|
||||
image : example-img.png
|
||||
---
|
||||
```
|
||||
</Note>
|
||||
Reference in New Issue
Block a user