### 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 ``` -------------------------------- ### Apply Markdown Emphasis Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md Use these patterns for bold, italic, combined styles, and inline code formatting. ```markdown **bold text** *italic text* ***bold and italic*** `inline code` ``` -------------------------------- ### Register a sidebar widget using PHP Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/dynamic-sidebar-widgets.md Use this filter to render HTML content directly from the server. The snippet adds a new widget to the sidebar array. ```php add_filter('fluent_support/widgets/ticket_sidebar', function ($widgets, $data) { $widgets[] = [ 'type' => 'html', 'title' => 'My Widget', 'icon' => 'Star', 'content' => '

Ticket #' . $data['ticket']->id . '

', ]; return $widgets; }, 10, 2); ``` -------------------------------- ### Embed Support Portal Shortcode Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/setup-configuration/adding-multiple-business-inboxes.md Use this shortcode to display a support portal for a specific business inbox. Replace the business_box_id value with the ID found in your inbox settings. ```text [ fluent_support _portal show_logout = ‘yes’ business_box_id=2 ] ``` -------------------------------- ### Display Login Form Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md Displays the built-in login form for non-logged-in users. ```text [fluent_support_login] ``` -------------------------------- ### Display Business Inbox Portal Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md Generates a support portal for a specific business inbox. ```text [fluent_support_portal show_logout = yes business_box_id=2] ``` -------------------------------- ### Configure Agent Portal Base URL Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/forntend-agent-portal.md Add this filter to your child theme's functions.php or a code snippet plugin to ensure ticket notification links point to the correct frontend URL. ```php add_filter('fluent_support/portal_admin_base_url', function ($url) { $url = 'https://your-forntend-support-page-fullurl/#/'; return $url; }); ``` -------------------------------- ### Register a sidebar widget using JavaScript Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/dynamic-sidebar-widgets.md Inject a Vue.js component into the sidebar using the frontend hook system. Ensure the 'fluent_support_widgets_ready' event is dispatched to register the component. ```javascript fluentSupportAdmin.hooks.addFilter('ticket_sidebar', 'my_plugin', function(widgets) { widgets.push({ type: 'vue-component', title: 'My Widget', icon: 'Star', use_card: true, component: { props: ['data'], template: '
Ticket #{{ data?.ticket?.id }}
' } }); return widgets; }); window.dispatchEvent(new Event('fluent_support_widgets_ready')); ``` -------------------------------- ### Display Customer Portal with Logout Option Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/setup-configuration/customer-support-portal-dashboard.md Use this shortcode to embed the customer support portal on a WordPress page or post with the logout button enabled. ```shortcode [fluent_support_portal show_logout = yes] ``` -------------------------------- ### Display Login Form with Reset Password Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md Displays the login form with the password reset option enabled. ```text [fluent_support_login show-signup=false show-reset-password=true] ``` ```text [fluent_support_login show-reset-password=true] ``` -------------------------------- ### Push changes to fork Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/README.md Uploads your local commits to the remote feature branch on your fork. ```bash git push origin docs/improve-ticket-management ``` -------------------------------- ### Create Markdown Blockquotes Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md Use the greater-than symbol to denote quotes or important callout notes. ```markdown > This is a quote or important note ``` -------------------------------- ### Define Markdown Headings Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/CONTRIBUTING.md Use standard Markdown heading levels to structure page content. ```markdown # H1 - Page Title (only one per page) ## H2 - Major Sections ### H3 - Subsections #### H4 - Minor Points ``` -------------------------------- ### Register New MIME Type Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/setup-configuration/add-more-attachments-type.md Use this filter to add a new file extension and its corresponding MIME type to the allowed attachments list. ```php // Add a new MIME group to Fluent Support add_filter('fluent_support/mime_groups', function ($mimeTypes) { $mimeTypes['html'] = [ 'title' => __('HTML', 'fluent-support'), 'mimes' => [ 'text/html', ], ]; return $mimeTypes; }); ``` -------------------------------- ### Display Reset Password Form Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md Displays the standalone password reset form. ```text [fluent_support_reset_password] ``` -------------------------------- ### Display Logout Option Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/shortcodes.md Adds a logout option to the customer support portal dashboard. ```text [fluent_support_portal show_logout = yes] ``` -------------------------------- ### Add Custom Ticket Status via Filter Hook Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/ticket-management/filtering-sorting-searching-tickets.md Use this filter in your functions.php file to register a new ticket status group. Ensure the key and label are defined within the returned array. ```php add_filter(‘fluent_support/ticket_status_groups’, function($statuses){ $statuses[‘unread’] = [‘Unread’]; return $statuses; }); ``` -------------------------------- ### Modify Existing MIME Groups Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/setup-configuration/add-more-attachments-type.md Use this filter to append additional MIME types to an existing group, such as adding AVIF support to the images category. ```php // Add a new MIME type to the existing MIME groups in Fluent Support add_filter('fluent_support/mime_groups', function ($mimeTypes) { $mimeTypes['images']['mimes'][] = 'image/avif'; return $mimeTypes; }); ``` -------------------------------- ### Public Ticket ID Smart Code Usage Source: https://github.com/wpmanageninja/fluent-support-user-docs/blob/master/docs/setup-configuration/public-ticket-numbers.md Use the {{ticket.public_id}} smart code in email notification templates to display the public ticket identifier. ```text [{{ticket.public_id}}] We received your support request: {{ticket.title}} ``` ```text [FS-1042] We received your support request: Login issue on mobile ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.