Skip to main content

Introduction

About This Documentation​

Purpose​

This documentation serves as the comprehensive product manual for Deepdesk, covering all existing features including architecture and technical implementation. It's designed to support the transition to new leadership and provide a complete reference for the platform.

Target Audiences​

This documentation is organized to serve multiple audiences:

🚀 Customer Success & Administrators​

  • User Guides: Step-by-step configuration and setup instructions
  • Access Control: Managing users, roles, and permissions
  • Platform Integrations: Connecting Deepdesk to your CX platforms
  • Best Practices: Recommended configurations and workflows

👨‍💻 Developers & Technical Teams​

  • Developer Guides: Architecture, data models, and technical implementation
  • API References: Integration details and code examples
  • Authentication & Security: OAuth2, SSO, API keys, and permissions system
  • Platform SDKs: Technical integration guides
DeepWiki

For more in-depth technical information per repo, also check out our AI-managed DeepWiki powered by Devin.

Documentation Structure​

Feature Organization​

Documentation is organized by feature domain, making it easy to find related information:

  • 🛠️ Administration: Administrative features (authentication, access control, accounts, platform integrations)
  • 💬 Agent Assist: Real-time agent productivity tools
  • 🤖 CX Assistants: AI-powered automation and intelligent assistants
  • 📞 Voice Agents: Voice channel automation

Content Model​

Each feature section follows a consistent three-part structure:

1. Overview (index.md)​

  • Purpose and benefits
  • How it fits into the Deepdesk ecosystem
  • Key capabilities
  • Links to related features

2. User Guide​

  • Step-by-step configuration instructions
  • Usage examples and screenshots
  • Troubleshooting and best practices
  • Role-specific guidance (Admin setup, Agent usage)

3. Developer Guide​

  • Architecture and data models
  • API endpoints and integration details
  • Authentication and security considerations
  • Code examples and technical references
  • Implementation details

This structure ensures that each audience can quickly find the information they need without wading through irrelevant details.

Getting Started​

For Administrators​

  1. Start with Administration to set up users and SSO
  2. Review Platform Integrations to connect your CX platform
  3. Explore feature User Guides to configure specific capabilities

For Developers​

  1. Review Authentication Overview for integration basics
  2. Check feature Developer Guides for API references and technical details
  3. See Permissions System for access control implementation

Contributing to This Documentation​

This documentation is built with Docusaurus and automatically deployed to Firebase Hosting on updates to the main branch. To contribute, fork the repository and submit a pull request.

Making Changes​

  1. Documentation files are located in website/docs/
  2. Images and assets should be placed in website/static/img/
  3. Sidebar navigation is configured in website/sidebars.ts

Writing Guidelines​

When contributing to this documentation:

  • Follow the structure: Use the Overview → User Guide → Developer Guide pattern
  • Write for your audience: Keep language appropriate for the intended readers
  • Use clear headings: Make content scannable with good heading hierarchy
  • Include examples: Code snippets, screenshots, and diagrams improve understanding
  • Cross-reference: Link to related documentation to help users discover connected features
  • Keep it current: Update documentation when features change

Style Guidelines​

  • Be concise: Get to the point quickly
  • Use active voice: "Configure the setting" not "The setting can be configured"
  • Include context: Explain why something matters, not just what it is
  • Test instructions: Verify that steps work before documenting them
  • Avoid jargon: Explain technical terms when they're necessary

Documentation Standards​

This documentation follows industry best practices for SaaS product documentation:

  • Task-oriented: Organized around what users want to accomplish
  • Role-specific: Content tailored to different audience needs
  • Searchable: Structured for easy discovery
  • Version-controlled: Maintained as code in Git
  • Continuously updated: Kept in sync with product changes

For more details, see CLAUDE.md in the repository root.

Additional Resources​

  • Repository: Source code and documentation files
  • Deployment: Automatically deployed to Cloud CDN on updates
  • Support: Contact your Deepdesk administrator or technical lead