Skip to main content

Navigating our documentation

PurposeDiscover how our official documentation webpage is structured and learn the best ways to navigate through it.
CreatedAugust 21, 2024

Homepage​

When you visit the docs.dtact.com webpage, you will be greeted with an overview of our company, emphasizing what sets us apart from others in the industry. Here you will find a Get Started button in the center of the page, inviting you to explore our product documentation.

In the top right corner you will find:

  • Community: This link will take you to our social media accounts on LinkedIn, GitHub, and X.com.

  • dtact.com: Selecting this will direct you to our company website, where you can learn more about our services, our team, and request additional information.

  • Sun/Moon icon: This feature allows you select between light and dark mode for the documentation website.

  • Search bar: Use the search bar to quickly locate specific information within our documentation, making it easier to find exactly what you need.

In the top left corner, you'll find:

  • DTACT: Click here to return to the homepage (www.docs.dtact.com).

  • Raven: This link will take you directly to the Raven documentation, providing in-depth details about the platform.

  • Honeytrap: This option directs you to the official documentation for the HoneyTrap framework.

Getting Started​

After selecting the Getting Started button, you will be introduced to Raven, starting with an overview that explains what Raven is and highlights its four foundational pillars. This section is designed to give you a high-level understanding of Raven's capabilities and how it can be used effectively.

The page layout is divided into three main sections:

  • Left Section: This area displays all available supporting materials.

  • Center Section: The central section features the main documentation, where you can read through detailed explanations and instructions.

  • Right Section: On the right, a table of contents provides an organized overview of all sections and subsections within the documentation.

Documentation Structure​

Our official documentation is organized into eight main sections, each designed to guide you through different aspects of the Raven Portal:

  1. Getting Started: This section introduces you to the Raven Portal and includes a terminology document that will help you familiarize yourself with specific terms used throughout the platform.

  2. Engine: The Engine Module is the core of the Raven Portal. Here, you will find detailed information about Bricks, including their management and the different types available. Additionally, this section covers how to create and manage secrets, and provides instructions on editing and managing your account settings.

  3. Fusion: The Fusion Module focuses on data management and aggregation. This section provides comprehensive details on the Raven components that allow you to aggregate and manage data within the portal, such as, Flows and Tables.

  4. Action: As its name suggests, the Action Module is all about automation. This section includes documentation on how to use Playbooks, Forms, and Playbook Bricks to automate tasks and streamline workflows.

  5. Insights: The Insights Module helps you visualize data effectively. This section offers guidance on setting up data visualizations for easier analysis, covering features such as Insight Panes and Dashboards.

  6. Other Apps: Some components of the Raven Portal do not fall direclty into a single module. In this section, you’ll find information on tools like Case Management, HoneyTrap and HoneyFarms, Santa, and OS Query, which can be applied across different modules of the Raven Portal.

  7. Technical Scripts: This section provides you with useful scripts that may need to be configured within different components of the portal. For example, you’ll find Schema scripts that assist in organizing Tables effectively.

  8. Frequently Asked Questions: This section gathers some of the most frequently asked questions clients have, helping you to understand better the Raven Portal.

Depending on the module or section you are exploring, you may also find additional resources such as User Stories, Flowcharts, and more technical documentation. These are designed to help you better understand how to configure and optimize the platform to meet your specific needs.