RogIQ logoRogIQ logo RogIQ
Getting Started Using the Help Desk and Resources

Welcome to the RogIQ documentation hub! Whether you are a marketer looking to build your first AI-powered campaign or a developer integrating our billing APIs, this guide will help you navigate our master indices, browse categories, and find the exact resources you need.

Our documentation is split into two main areas: the Help Desk for product users, and the Technical Index for developers and system administrators.

Help Desk Knowledge Base

End-user guides, tutorials, and workflows for using the RogIQ platform.

Technical Documentation

API references, architecture decisions, and developer implementation guides.

The Help Desk is your go-to resource for learning how to use RogIQ's features. Every article in the Help Desk follows a consistent, easy-to-read template:

  1. Overview — What the feature does and why it matters.

  2. How It Works — Step-by-step instructions.

  3. Screenshots / Videos — Visual walkthroughs to guide you.

  4. Frequently Asked Questions — Quick answers to common hurdles.

Help Desk Categories

To make finding information easy, the Help Desk is organized into logical categories based on what you want to achieve. Expand the sections below to see what's covered in each area:

Getting Started & Brand Setup

Learn the basics of setting up your RogIQ environment.

  • Getting Started: Account creation, onboarding, and dashboard navigation.

  • Brand Setup: Defining your brand identity, voice, visuals, and AI intelligence.

  • Team & Settings: Managing team roles, notifications, and social media connections.

Content Creation & Strategy

Everything you need to plan, write, and publish content.

  • Strategy: Audience definition, competitive landscape, and quarterly planning.

  • Content Planning: The content editor, blog posts, social media carousels, and approval workflows.

  • Genius Mode: Using our autonomous AI content agent.

  • Collaterals: Designing and exporting marketing materials.

SEO, Campaigns & Analytics

Tools to measure and improve your marketing performance.

  • SEO Tools: Audits, search insights, and metadata management.

  • AI Optimization (AIO): Tracking your brand's visibility in AI tools like ChatGPT.

  • Campaigns: Building and automating marketing campaigns.

  • Performance & Reporting: Custom reports and website performance data.

Websites, Leads & Agencies

Advanced tools for managing your web presence and clients.

  • Website Management: The AI website builder, WordPress integration, and chatbots.

  • Lead Lists & Forms: Building prospect lists and embedding capture forms.

  • RogMail: Managing subscribers and sending newsletters.

  • Agency Users: Managing multiple client companies, white-labeling, and agency analytics.

For developers, system administrators, and integration partners, the Master Technical Index (docs/INDEX.md) serves as the central directory for all system architecture, APIs, and codebase documentation.

Here is a quick overview of the technical resource categories:

CategoryWhat You'll FindKey Documents
Core ArchitectureSetup guides, project status, and MVP criteria.SETUP.md, PROJECT_STATUS.md
Auth & SecurityPasswordless auth, compliance, and security audits.MAGIC_LINK_AUTH.md, COMPLIANCE_SECURITY_GUIDE.md
Billing & PaymentsStripe integration, overage billing, and payment gateways.BILLING_API.md, STRIPE_INTEGRATION.md
AI & IntelligenceMulti-agent collaboration, audio AI, and voice intake APIs.AI_ENGINE.md, VOICE_INTAKE_API.md
InfrastructureRails 8 features, Zeitwerk naming, and deployment operations.RAILS_8_GUIDE.md, ZEITWERK_DEPLOYMENT_GUIDE.md

Technical documentation is heavily version-controlled. Always check the Last Updated date at the top of technical guides to ensure you are looking at the most current implementation details.

Searching for Answers

If you aren't sure which category your question falls under, searching is the fastest way to find what you need.

  1. 1

    Identify your core topic

    Determine the main keyword for your issue. For example, if you are struggling with logging in, use "auth" or "login". If you are setting up payments, use "billing" or "stripe".

  2. 2

    Look for specific document types

    Our documentation uses standard naming conventions to help you filter results:

    • Guides: End-to-end explanations (e.g., *GUIDE.md)

    • Quick Starts: Fast implementation steps (e.g., *QUICK_START.md)

    • APIs: Technical endpoint references (e.g., *API*.md)

  3. 3

    Use developer search commands (Technical Users)

    If you are working locally within the repository, use terminal commands to quickly locate files:

    # Search all documentation for a specific keyword
grep -r "magic link" docs/

# Find specific API files
find docs -name "*API*"

# List all Quick Start guides
ls docs/*QUICK_START.md

Common Search Keywords:

  • Authentication: "auth", "magic link", "jwt"

  • Billing: "billing", "stripe", "payment"

  • AI Features: "intelligence", "learning", "multi-agent", "genius mode"

  • Frontend: "frontend", "react", "ui"

Getting Additional Help

Still can't find what you're looking for? Here is where to go next:

  • Setup & Installation Issues: Refer to the SETUP.md guide in the root directory.

  • API or Integration Questions: Check the feature-specific API guides (e.g., BILLING_API_DEVELOPER_GUIDE.md).

  • Testing Help: Review the consolidated TESTING_GUIDE.md.

  • Deployment Help: See the STAGING_PRODUCTION_GUIDE.md.

If you've exhausted the documentation and still need assistance, reach out to your account manager or drop a message in the internal support channels.