> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ruby.ad/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

Welcome to Ruby! If you are here, it's because you are an Admin of your workspace. As an Admin, you have full admin rights. See more about [Memberships & Roles](https://docs.ruby.ad/docs/user-documentation/getting-started/ruby-rollout-guide/admin-guide-set-up-your-ruby-workspace.md).

You can set-up multiple parameters for your workspace by going to the Admin Panel.

In order to make the most out of Ruby, here are the steps we recommend.

You can use Ruby without data sources, but Ruby is most useful when connected to your knowledge bases. As an admin, you have the ability to manage data sources and make them available for all members of your workspace.

There are various types of Data Sources:

* **Managed Connections:** your main communication and knowledge tools, they get synchronized automatically, so Ruby can always have access to recent information
* **Public Websites:** ingest data from public websites with our web crawler, which you can refresh at the cadence you want
* **Folders:** store static information in a folder, just like you would on your computer.

> [!CAUTION]
>
> **About sharing data and permissions**
>
> * Even once synchronized, your data is not yet shared nor usable with your workspace members. You can make the connected data available to other people in your workspace by adding it to a [space](https://docs.ruby.ad/docs/user-documentation/data-sources/overview.md).
> * When adding a connection, you can select exactly which channels or folders you want Ruby to have access to.

**How to add my first connection**

Go to **Spaces** > **Connections**, select the desired Connection, click **Connect > Authenticate your account**, and select the data you wish to synchronize with Ruby.

To get help on how to set-up the various connections, you can refer directly to [Connections](https://docs.ruby.ad/docs/user-documentation/data-sources/connections.md).

Now that you have built the first steps of your connections, you can start putting Ruby to work. A very useful agent in your journey is the **@ruby** agent.

**@ruby** is created to help you **answer questions by looking into your company data**. Think about it as your company data researcher, or "Perplexity for internal data". It works using [Retrieval Augmented Generation](https://docs.ruby.ad/docs/user-documentation/agents/llm-best-practices/understanding-rag.md).

**What @ruby can access**

* **@ruby** uses the data in **Company Data**, the default Space of your workspace. To make data available to **@ruby**, add it to Company Data.
* **@ruby** doesn't search other [Spaces](https://docs.ruby.ad/docs/user-documentation/admins/spaces-management.md) on its own, whether they're open or restricted. To use that data:
  * **In one conversation:** type `/` in the message bar, choose **Attach**, and pick a document or folder from any Space you have access to. If it comes from a restricted Space, only members of that Space can access the conversation.
  * **For repeated use:** build an agent that has that data as [knowledge](https://docs.ruby.ad/docs/user-documentation/agents/knowledge/index). Only members of the Spaces the agent uses can see and use it.
* In a Pod, **@ruby** also uses the Pod's [files and linked data](https://docs.ruby.ad/docs/user-documentation/pods/files.md).
* There's no setting to choose which data sources **@ruby** uses. Admins can only enable or disable it.

One great use of Ruby is to call the agents directly in Slack. The agent can use the ongoing conversation as context, and anybody in the Slack channel will be able to see the answer.

1. [Install and authorize the Ruby app in Slack](https://docs.ruby.ad/docs/user-documentation/agents/integrations/ruby-in-slack/index#set-up-the-ruby-app-admins).
2. Add the Ruby app to your Slack channels.
3. You're all set! All workspace members can interact with @ruby directly in Slack.

> [!CAUTION]
>
> **About Slack Settings**
>
> * To export your @ruby conversation history in Slack, remember that it's like exporting direct messages. You can only do this if you're an Owner or admin of a Slack Business+ or Enterprise Grid account.

That's it! You're all set to make the most out of Ruby!


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.