This page walks your team through a first run with Dosu, from signing in to seeing your first drafts. The whole setup takes roughly five minutes, and nothing Dosu produces is posted publicly until you decide it should.
You will sign in, create a Library and connect a Source, create an Agent, and review Dosu's first drafts in preview mode.
Before you start#
Ensure you have a GitHub account and permission to install a GitHub App on the organization or repositories you want Dosu to learn from. If you do not have that permission, ask whoever administers your GitHub organization to approve the install.
1. Sign in#
Go to app.dosu.dev and choose Sign in with GitHub. Dosu uses your GitHub identity to sign you in and to connect repositories in the next step. The first person to sign in for your company creates the organization, and teammates you invite later join it.
2. Create a Library and connect a Source#
A Library is a knowledge base for a project, team, or product area. Sources, Documents, and settings live inside it.
- Open Libraries and select Create a library (or go straight to create a Library).
- Give the Library a name that matches the project or team it covers.
- Connect a Source while creating the Library. Choose GitHub and pick the repositories Dosu should learn from. If the Dosu GitHub App is not installed yet, you will be prompted to install it and grant read access.
Dosu reads the activity in a connected Source (issues, pull requests, discussions, and code) and uses it to answer questions and draft Documents. A Library can hold more than one Source, so you can start with a single repository and add more later.
GitHub is generally available today. Slack and Notion are also available on the Teams plan, and you can add them to a Library once it exists.
3. Create an Agent#
An Agent is how Dosu shows up on a platform to answer questions and take action. Agents draw their knowledge from a Library, so create the Library first.
- After the Library is set up, choose Create an agent, or open Agents and select create an Agent.
- Point the Agent at the Library you just created.
- Pick the platform it answers on, such as GitHub, and choose how it should respond.
Once the Agent is live, you can mention @dosu on an issue, pull request, or discussion in a connected repository, and Dosu replies with context from your Sources.
4. Preview, then Review before anything posts#
New Agents start in preview mode. While an Agent is in preview, Dosu drafts responses but does not post them publicly. Each draft is queued for you on the Review page.
On the Review page, you can:
- Accept a draft to post or publish it.
- Edit a draft, then accept your edited version.
- Decline a draft you do not want.
You get the same controls everywhere Dosu drafts something, including the in-PR review comment with Accept, Edit, and Decline. Stay in preview for as long as you like. When your team is confident in the drafts, publish responses from the Review page or update the Agent to publish automatically. This setup scales from a single repository to an entire company.
Next steps#
- How Dosu Works explains what happens behind the scenes.
- Libraries and Agents cover the core pieces in detail.
- Review goes deeper on approving, editing, and declining drafts.
- Connecting GitHub and Connecting Slack walk through each Source.
- Glossary defines Library, Source, Agent, Monitor, and the rest.
