docsData.js

Go to the documentation of this file.

// Centralized documentation content and structure
// Each doc has: slug, title, icon, summary, and sections [{ heading, body?, steps?, list? }]
 
export const docGroups = [
  {
    title: 'Getting Started',
    id: 'getting-started',
    items: [
      {
        slug: 'overview',
        title: 'Overview',
        icon: 'menu_book',
        summary: 'What the IBG MSP Platform offers and how it fits your workflow.',
        sections: [
          {
            heading: 'Welcome',
            body: 'The IBG MSP Platform unifies Remote Monitoring & Management (RMM) with Professional Services Automation (PSA) in a multi-tenant architecture designed for MSPs.'
          }
        ]
      },
      {
        slug: 'quick-start',
        title: 'Quick Start',
        icon: 'rocket_launch',
        summary: 'Create an account, configure your org, and deploy agents.',
        sections: [
          {
            heading: 'Steps',
            steps: [
              {
                title: 'Create Your Account',
                text: 'Sign up or log in to your workspace.'
              },
              {
                title: 'Set Up Organization',
                text: 'Configure profile, branding, and default settings.'
              },
              {
                title: 'Deploy Agents',
                text: 'Install monitoring agents on endpoints to start reporting metrics.'
              }
            ]
          }
        ]
      },
      {
        slug: 'themes',
        title: 'Changing Themes',
        icon: 'palette',
        summary: 'Customize your dashboard appearance with light, dark, and accessibility themes.',
        image: '/images/docs/dashboard-theme.png',
        sections: [
          {
            heading: 'Available Themes',
            body: 'The platform offers 7 theme options to match your preferences and accessibility needs:',
            list: [
              'System - Automatically matches your operating system preference',
              'Light - Clean, bright interface ideal for well-lit environments',
              'Dark - Easy on the eyes in low-light conditions, reduces eye strain',
              'Blue - Professional blue-accented interface',
              'Green - Nature-inspired green accents with a calming palette',
              'High Contrast - Maximum readability with stark black/white contrast and bold text',
              'Colorblind - Scientifically-tested colors safe for all types of color vision deficiency'
            ]
          },
          {
            heading: 'Changing Theme from Header',
            body: 'The quickest way to switch themes is using the theme selector in the navigation header.',
            steps: [
              {
                title: 'Locate the Theme Button',
                text: 'Look for the theme icon in the top navigation bar (it shows a palette, sun, or moon icon depending on your current theme).'
              },
              {
                title: 'Open Theme Menu',
                text: 'Click the theme button to open a dropdown menu showing all available themes.'
              },
              {
                title: 'Select Your Theme',
                text: 'Click on any theme name to apply it immediately. The interface will update instantly.'
              },
              {
                title: 'Automatic Save',
                text: 'Your selection is saved automatically and will persist across sessions and devices.'
              }
            ]
          },
          {
            heading: 'Changing Theme in Settings',
            body: 'You can also change your theme from the Settings page for a more detailed configuration experience.',
            steps: [
              {
                title: 'Navigate to Settings',
                text: 'Click on "Settings" in the main navigation menu.'
              },
              {
                title: 'Find Display Section',
                text: 'Scroll to the "Display Preferences" section where theme options are located.'
              },
              {
                title: 'Select Theme',
                text: 'Choose your preferred theme from the dropdown menu.'
              },
              {
                title: 'Save Changes',
                text: 'Click "Save Display Settings" to apply your selection.'
              }
            ]
          },
          {
            heading: 'Accessibility Themes',
            body: 'Two specialized themes are available for enhanced accessibility:',
            list: [
              'High Contrast - Features pure black text on white backgrounds with 21:1 contrast ratio (WCAG AAA), thick 2-3px borders, and bold fonts for maximum legibility. Perfect for users with low vision or viewing in bright sunlight.',
              'Colorblind - Uses a scientifically-tested color palette that works for all types of color blindness. Includes visual symbols (✓, ⚠, ✗) alongside colors to ensure status indicators are always distinguishable.'
            ]
          },
          {
            heading: 'System Theme Behavior',
            body: 'When you select "System" theme, the platform automatically matches your operating system\'s light or dark mode preference. If you change your OS preference, the platform theme will update automatically without requiring a page refresh.'
          },
          {
            heading: 'Theme Persistence',
            body: 'Your theme preference is saved in two places: locally in your browser and in your user profile on the server. This means your theme will be consistent across all your devices and will persist even if you clear your browser data.'
          },
          {
            heading: 'Tips',
            list: [
              'Try the High Contrast theme if you find text difficult to read',
              'Use the Colorblind theme if you have difficulty distinguishing status colors',
              'Dark theme is recommended for extended use in low-light environments',
              'System theme is great if you switch between day and night work schedules'
            ]
          }
        ]
      }
    ]
  },
  {
    title: 'Pages',
    id: 'pages',
    items: [
      {
        slug: 'dashboard',
        title: 'Dashboard',
        icon: 'space_dashboard',
        summary: 'Your high-level MSP overview: tickets, alerts, agents, and billing.',
        image: '/images/docs/dashboard-real.png',
        sections: [
          {
            heading: 'At a Glance',
            list: [
              'Active Tickets: Open or in-progress requests',
              'Critical Alerts: Unread alerts from agents and systems',
              'Online Agents: Endpoints reporting in',
              'Invoiced/Payments This Month: Voided invoices are excluded'
            ]
          },
          {
            heading: 'Tips',
            body: 'Use the refresh action to fetch the latest metrics.'
          }
        ]
      },
      {
        slug: 'tickets',
        title: 'Tickets',
        icon: 'confirmation_number',
        summary: 'Create, triage, and resolve customer requests with SLAs.',
        image: '/images/docs/dashboard-tickets.png',
        sections: [
          {
            heading: 'Workflow',
            steps: [
              { title: 'Create a ticket', text: 'Tickets → New. Enter title, description, priority, and customer.' },
              { title: 'Update status', text: 'Assign, change priority, and close when resolved.' },
              { title: 'Search & filter', text: 'Use the search bar and filters for status/priority/date.' }
            ]
          }
        ]
      },
      {
        slug: 'customers',
        title: 'Customers',
        icon: 'groups',
        summary: 'Manage customer records and view related tickets and invoices.',
        image: '/images/docs/dashboard-customers.png',
        sections: [
          {
            heading: 'Basics',
            list: [
              'Add a customer: Customers → New',
              'Search: Filter by name, email, or tags',
              'Profile: View associated tickets, invoices, and contracts'
            ]
          }
        ]
      },
      {
        slug: 'knowledge-base',
        title: 'Knowledge Base',
        icon: 'menu_book',
        summary: 'Create and maintain documentation for internal or customer use.',
        image: '/images/docs/dashboard-kb.png',
        sections: [
          {
            heading: 'Authoring',
            list: [
              'New article: Knowledge Base → New',
              'Edit: Open an article and choose Edit',
              'Search: Find articles by title or content'
            ]
          }
        ]
      },
      {
        slug: 'products',
        title: 'Products',
        icon: 'inventory_2',
        summary: 'Billable items and stock-managed products for invoicing.',
        image: '/images/docs/dashboard-products.png',
        sections: [
          {
            heading: 'Catalog',
            list: [
              'Add product: price (ex GST), stock tracking, low stock alerts',
              'Search: Filter by name or supplier',
              'Use in invoices: Add products to line items for consistent pricing'
            ]
          }
        ]
      },
      {
        slug: 'invoices',
        title: 'Invoices',
        icon: 'receipt_long',
        summary: 'Create, edit, void, and delete invoices with stock restocking.',
        image: '/images/docs/dashboard-invoices.png',
        sections: [
          {
            heading: 'Lifecycle',
            steps: [
              { title: 'Create', text: 'Invoices → New. Select customer, add items, save.' },
              { title: 'Edit', text: 'Update items and dates; totals update automatically.' },
              { title: 'Void', text: 'Choose Void, enter a reason; stock is restocked, reports exclude voided.' },
              { title: 'Delete', text: 'Allowed for Draft or Voided (not Paid); deletes items and restocks if needed.' }
            ]
          },
          {
            heading: 'Note',
            body: 'Company info (ABN, address) is configured in Settings and appears on printed invoices.'
          }
        ]
      },
      {
        slug: 'purchase-orders',
        title: 'Purchase Orders',
        icon: 'shopping_cart',
        summary: 'Track purchase orders, receiving, and stock updates.',
        image: '/images/docs/dashboard-po.png',
        sections: [
          {
            heading: 'Process',
            list: [
              'Create PO: Add supplier, items, expected dates',
              'Edit/Receive: Update lines as goods arrive',
              'Search: Filter by PO number, supplier, date'
            ]
          }
        ]
      },
      {
        slug: 'contracts',
        title: 'Contracts',
        icon: 'contract_edit',
        summary: 'Define service contracts, SLAs, and entitlements per customer.',
        image: '/images/docs/dashboard-contracts.png',
        sections: [
          {
            heading: 'Details',
            list: [
              'Create/Edit: Set start/end, SLA hours, billing terms',
              'Tenant visibility: Root admins can see tenant context in lists',
              'Reporting: Contracts integrate with tickets and billing'
            ]
          }
        ]
      },
      {
        slug: 'monitoring',
        title: 'Monitoring',
        icon: 'monitor_heart',
        summary: 'View metrics from deployed agents and set alert thresholds.',
        image: '/images/docs/dashboard-monitoring.png',
        sections: [
          {
            heading: 'Signals',
            list: [
              'Agents: Deploy to endpoints to report CPU, memory, disk',
              'Alerts: Configure thresholds in Settings → Notifications',
              'Incidents: Critical alerts appear on the Dashboard'
            ]
          }
        ]
      },
      {
        slug: 'agents',
        title: 'Agents',
        icon: 'smart_toy',
        summary: 'See agent status, last seen, and assigned tickets.',
        image: '/images/docs/dashboard-agents.png',
        sections: [
          {
            heading: 'Overview',
            list: [
              'Status: Online agents report in within the last 5 minutes',
              'Assignments: View tickets linked to agents'
            ]
          }
        ]
      },
      {
        slug: 'reports',
        title: 'Reports',
        icon: 'insights',
        summary: 'Analyze revenue, customer activity, and invoice aging.',
        image: '/images/docs/dashboard-reports.png',
        sections: [
          {
            heading: 'Dashboards',
            list: [
              'Revenue: Monthly totals (voided invoices excluded)',
              'Top Customers: By revenue and ticket count',
              'Invoice Aging: Overdue breakdown across time buckets'
            ]
          }
        ]
      },
      {
        slug: 'integrations',
        title: 'Integrations',
        icon: 'extension',
        summary: 'Connect Slack, Xero, Mailgun, Splashtop per tenant.',
        image: '/images/docs/dashboard-integrations.png',
        sections: [
          {
            heading: 'Setup',
            list: [
              'Enable: Choose a provider and configure credentials',
              'Per-tenant: Root admins can manage integrations for any tenant'
            ]
          }
        ]
      },
      {
        slug: 'settings',
        title: 'Settings',
        icon: 'tune',
        summary: 'Customize general, company, tax, notifications, and display.',
        image: '/images/docs/dashboard-settings.png',
        sections: [
          {
            heading: 'Areas',
            list: [
              'General: Company name, timezone, date format',
              'Company: ABN, address, phone, email',
              'Tax: Default GST rate',
              'Notifications: Email/Slack and alert thresholds',
              'Display: Theme and items per page',
              'Tenant control: Root admins select a tenant to load/save tenant-specific settings'
            ]
          }
        ]
      }
    ]
  },
  {
    title: 'Support',
    id: 'support',
    items: [
      {
        slug: 'faq',
        title: 'FAQ',
        icon: 'help',
        summary: 'Common questions and answers.',
        sections: [
          {
            heading: 'General',
            list: [
              'Tenants: Unlimited tenants supported'
            ]
          }
        ]
      },
      {
        slug: 'troubleshooting',
        title: 'Troubleshooting',
        icon: 'bug_report',
        summary: 'Fix common setup and runtime issues.',
        sections: [
          {
            heading: 'Docker permissions',
            body: 'If you see permission denied on /var/run/docker.sock, run with sudo or add your user to the docker group.'
          },
          {
            heading: 'Backend cannot connect to DB',
            list: [
              'Verify database container is running',
              'Check connection string and credentials',
              'Confirm network and ports are accessible'
            ]
          }
        ]
      },
      {
        slug: 'contact-support',
        title: 'Contact Support',
        icon: 'support_agent',
        summary: 'How to get help when you need it.',
        sections: [
          {
            heading: 'Contact',
            body: 'Reach out via your support channel or email with logs and steps to reproduce.'
          }
        ]
      }
    ]
  }
];
 
export function findDoc(slug) {
  for (const group of docGroups) {
    const match = group.items.find((i) => i.slug === slug);
    if (match) return { group, doc: match };
  }
  return null;
}