# Wawp AI Guide & Supported Shortcodes

This document provides a guide for any AI (like ChatGPT, Claude, Gemini) when writing, generating, or modifying Markdown articles for the Wawp Help Center.

## Shortcodes & Components
Our Markdown parser supports custom shortcodes to render rich UI components. Please use them where appropriate to enhance the documentation.

### 1. Dashboard Links
Use this to link users to specific sections inside their WordPress Wawp Dashboard.
```markdown
[wawp_dashboard_link title="Go to Dashboard" description="Customize which features are enabled to match your preferences." path="/wp-admin/admin.php?page=wawp&wawp_section=dashboard"]
```
- **title**: The button/link title.
- **description**: A short description of where it leads.
- **path**: The relative path inside WordPress (usually `/wp-admin/admin.php?page=wawp&wawp_section=...`).

### 2. Steps Component
Use this to render a nice UI for step-by-step guides.
```markdown
[wawp_steps]
[wawp_step title="Access Subscriptions"]From your WordPress dashboard, go to **Wawp Dashboard** > **Subscriptions**.[/wawp_step]
[wawp_step title="Download & Install"]Click on the **Download and install** button to upgrade instantly.[/wawp_step]
[/wawp_steps]
```
- Wrap all steps in `[wawp_steps]`.
- Each step is wrapped in `[wawp_step title="Optional Title" number="Optional Number"]`. 
- Number is calculated automatically if omitted.

### 3. Callout Boxes
Use callouts to highlight important information, warnings, or tips.

**Info Callout:**
```markdown
[wawp_callout_info icon="ri-information-2-fill"]
This is an info box. You can override the icon using Remix Icon classes.
[/wawp_callout_info]
```

**Success Callout:**
```markdown
[wawp_callout_success]
Operation was successful!
[/wawp_callout_success]
```

**Warning Callout:**
```markdown
[wawp_callout_warning]
Be careful with this setting.
[/wawp_callout_warning]
```

**Danger Callout:**
```markdown
[wawp_callout_danger]
This will delete your data.
[/wawp_callout_danger]
```

**Blockquote:**
```markdown
[wawp_callout_blockquote author="Author Name"]
This is a blockquote component.
[/wawp_callout_blockquote]
```

### 4. API Endpoints Capsule
When describing an API request inside a `[wawp_step]`, if you format it exactly like this:
```markdown
**POST** [Endpoint Name](https://api.wawp.net/...)
```
The parser will automatically transform it into a specialized `code` UI block for API endpoints.

### 5. Premium Title
Use this for a specialized section header.
```markdown
[wawp_callout_premium_title]Advanced Settings[/wawp_callout_premium_title]
```

## Markdown Rules
- Use Standard GitHub Flavored Markdown (GFM).
- Start the file with a YAML frontmatter containing `title`, `excerpt`, `thumbnail`, `category_id`, `language`, `slug`, `views`, `created_at`, `updated_at`.
- Use heading level 3 (`###`) for main sections.
- Keep the language consistent with the file suffix (e.g. `.en.md` or `.ar.md`).