Fluent Support

https://github.com/wpmanageninja/fluent-support-user-docs
Admin
Fluent Support is a helpdesk and customer support ticketing system plugin for WordPress designed to...
Tokens:26,158
Snippets:549
Trust Score:9.2
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Set up the development environment

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Commands to clone the repository, install dependencies, and start the local development server.

```bash
# Fork the repository on GitHub
# Clone your fork
git clone https://github.com/YOUR_USERNAME/fluent-support-user-docs.git
cd fluent-support-user-docs

# Install dependencies
npm install

# Start development server
npm run docs:dev
```

--------------------------------

### Install Dependencies

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Command to install all required project dependencies.

```bash
npm install
```

--------------------------------

### Run Help Scout Ticket Import

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/migration/helpscout-ticket-migrator.md

Execute the WP-CLI command to start or resume the ticket migration process.

```bash
wp fluent_support helpscout_ticket_import \
  --access_token=YOUR_ACCESS_TOKEN \
  --mailbox_id=12345
```

--------------------------------

### Run Zendesk ticket import via WP-CLI

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/migration/zendesk-ticket-migrator.md

Executes the ticket migration process from the command line. Requires Fluent Support Pro and WP-CLI installed.

```bash
wp fluent_support zendesk_ticket_import \
  --domain=https://yourcompany.zendesk.com \
  --email=admin@yourcompany.com \
  --access_token=YOUR_API_TOKEN
```

```bash
wp fluent_support zendesk_ticket_import \
  --domain=https://yourcompany.zendesk.com \
  --email=admin@yourcompany.com \
  --access_token=YOUR_API_TOKEN \
  --include_archived
```

--------------------------------

### Clone and Navigate Repository

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Initial steps to download the project and enter the directory.

```bash
git clone https://github.com/WPManageNinja/fluent-support-user-docs.git
cd fluent-support-user-docs
```

--------------------------------

### Test documentation locally

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Command to run the development server for testing changes.

```bash
npm run docs:dev
```

--------------------------------

### Create Lists

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use ordered lists for sequential steps and unordered lists for non-sequential items.

```markdown
1. First step
2. Second step
3. Third step
```

```markdown
- Feature one
- Feature two
- Feature three
```

--------------------------------

### Display Login Form with Create Account

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md

Displays the login form with the signup option enabled.

```text
    [fluent_support_login show-signup=true show-reset-password=false]
```

```text
    [fluent_support_login show-signup=true]
```

--------------------------------

### Implement Callouts

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use VitePress callout syntax to highlight important information.

```markdown
::: tip
Helpful tips and best practices
:::

::: warning
Important warnings users should know
:::

::: danger
Critical warnings about potential issues
:::

::: info
Additional information or context
:::
```

--------------------------------

### Create a feature branch

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Use this command to create and switch to a new branch for your documentation changes.

```bash
git checkout -b docs/improve-ticket-management
```

--------------------------------

### Add Callout Blocks

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Use these syntax blocks to highlight tips, warnings, or critical information within the documentation.

```markdown
::: tip
This is a helpful tip!
:::

::: warning
This is a warning message.
:::

::: danger
This is a critical warning!
:::
```

--------------------------------

### Create Markdown Task Lists

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use this syntax to represent checklists with completed and incomplete items.

```markdown
- [x] Completed task
- [ ] Incomplete task
- [ ] Another task
```

--------------------------------

### Display Signup Form

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md

Displays the standalone signup form for new users.

```text
    [fluent_support_signup]
```

--------------------------------

### Project Directory Structure

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Overview of the file and folder organization within the project.

```text
fluent-support-user-docs/
├── .vitepress/
│   ├── config.js          # VitePress configuration
│   ├── theme/             # Custom theme files
│   └── dist/              # Built output (generated)
├── guide/
│   ├── getting-started/   # Getting started guides
│   ├── setup-configuration/ # Setup and configuration docs
│   ├── ticket-management/ # Ticket management features
│   ├── email-notifications/ # Email settings
│   ├── workflows-automation/ # Automation guides
│   ├── reports-analytics/ # Reporting documentation
│   ├── integrations/      # Integration guides
│   ├── ai-assistance/     # AI features documentation
│   ├── migration/         # Migration guides
│   ├── troubleshooting-support/ # FAQs and support
│   ├── changelog/         # Version history
│   └── public/            # Static assets (images, icons)
├── index.md               # Homepage
├── package.json           # Project dependencies
└── README.md              # This file
```

--------------------------------

### Add Links

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use standard Markdown syntax for internal and external links.

```markdown
[Link text](/page-slug)
```

```markdown
[Link text](https://example.com)
```

--------------------------------

### Create a new branch

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Command to create a new branch for documentation improvements.

```bash
git checkout -b docs/your-improvement
```

--------------------------------

### Display Agent Portal via Shortcode

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/forntend-agent-portal.md

Use this shortcode on any WordPress page to render the frontend agent portal interface.

```shortcode
[fluent_support_admin_portal]
```

--------------------------------

### Insert Images

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use Markdown image syntax with descriptive alt text.

```markdown
![Descriptive alt text](/images/category/feature/screenshot.png)
```

--------------------------------

### Create Markdown Tables

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use this syntax to define structured data tables in Markdown.

```markdown
| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data 1   | Data 2   | Data 3   |
| Data 4   | Data 5   | Data 6   |
```

--------------------------------

### Define Page Structure

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Follow this template to ensure consistent page organization.

```markdown
# Page Title

Brief introduction explaining what this page covers.

## Prerequisites

What users need before starting (if applicable).

## Main Content

Break into logical sections with H2 and H3 headings.

## Step-by-Step Guide

1. First step with clear instructions
2. Second step
3. Third step

## Examples

Provide practical examples.

## Troubleshooting

Common issues and solutions.

## Related Topics

- [Link to related doc 1]()
- [Link to related doc 2]()
```

--------------------------------

### Exchange App Credentials for Access Token

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/migration/helpscout-ticket-migrator.md

Use curl to exchange your Help Scout App ID and Secret for an access token required for the migration.

```bash
curl -X POST "https://api.helpscout.net/v2/tokens" \
  --data "grant_type=client_credentials&client_id=YOUR_APP_ID&client_secret=YOUR_APP_SECRET"
```

--------------------------------

### Display Customer Support Portal

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md

Use this shortcode to render the full customer support portal on a WordPress page or post.

```text
[fluent_support_portal]
```

--------------------------------

### Reference Images in Markdown

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Use absolute paths to reference images stored in the guide/public/images/ directory.

```markdown
![Alt text](/images/category/feature/screenshot.png)
```

--------------------------------

### Commit changes

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md

Stages and commits your documentation updates to the local repository.

```bash
git add .
git commit -m "docs: improve ticket management guide"
```

--------------------------------

### Display Authentication Form

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md

Use this shortcode to display only the authentication interface for verifying user login status.

```text
[fluent_support_auth]
```

--------------------------------

### Format Code Blocks

Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md

Use fenced code blocks with appropriate language identifiers for syntax highlighting.

```php
// PHP code
function example() {
    return true;
}
```

```javascript
// JavaScript code
const example = () => true;
```

```bash
# Terminal commands
npm install
```
Tokens:
Raw