Skip to content
EkLine Documentation

Set up your workspace

Set up EkLine for a new organization by working through these steps in order. When you finish, the agents can open pull requests in your docs, use your company’s context, and measure what AI assistants say about your product. The app does not walk you through these steps, so keep this page open while you work.

Before you begin

Section titled “Before you begin”
  • You signed up and verified your email. The person who creates the organization is its Owner.
  • You are the organization’s Owner or an Admin. Inviting members and claiming email domains need one of these roles.
  • To connect GitHub, you are an owner of the GitHub organization, or one of its owners can approve the request.
  • To connect GitLab instead, you can create a gitlab.com access token with the api and read_repository scopes.

Steps

Section titled “Steps”

  1. Connect GitHub or GitLab.

    Go to Settings > Integrations > GitHub Integration and install the EkLine GitHub App, or go to GitLab Integration and add an access token. Then select your docs repositories under Where EkLine writes, and the repositories where product changes land under What else EkLine can read. See Connect GitHub, Connect GitLab, and Docs platforms you keep.

  2. Invite members and set roles.

    Go to Settings > Organization > Members and click Invite Members. Add one email per row, select a role for each, and click Send Invites. Invites expire after 7 days.

    If you did not claim your company’s email domain when you signed up, claim it under Settings > Organization > Domains. Teammates who sign up with that domain are then offered to join your organization as Members. See Members and roles.

  3. Fill in your Company Profile.

    Go to Settings > Organization > Company Profile. Describe your product, audiences, competitors, and brand names, and add your Tone and Voice. Click Save Changes. See Company Profile and Domains for what each field does and which agent reads it.

  4. Add custom instructions.

    Go to Settings > Docs Agent > Custom instructions. Write the standing instructions the Docs Agent should follow, such as your spelling, heading style, or where your style guide lives, and click Save custom instructions. For the Marketing Agent, add its own instructions under Settings > Marketing Agent > Custom instructions. Instructions apply to sessions started after you save. See Custom instructions.

  5. Connect Slack and your other sources.

    Go to Settings > Integrations and click Connect on the Slack card, so your team can mention EkLine in a thread to ask for a docs change. Then connect the tools that hold your product context, such as Jira, Linear, Notion, Confluence, Google Drive, or PostHog. See the Integrations overview and Slack.

  6. Set up review rules or an Automation.

    To have EkLine check new pull requests in your code repositories for docs impact, set up automatic PR review and scope it with review rules. To run recurring work on a schedule, open Automations in the sidebar and start from a template such as Release Notes Generator or Docs Drift Review. See Automations.

  7. Run your first journey.

    Open Journeys in the sidebar and click New journey. Enter a question a buyer or developer would ask under What do you want to find out?, click Create scenario with AI to draft the rest, then click Try it once. See the Journeys overview.

    If you ran the report offered at sign-up, its results are already in the Buyer questions collection on the Collections tab.

Check it worked

Section titled “Check it worked”
  • Settings > Integrations > GitHub Integration no longer shows GitHub is not connected yet or Setup is not finished: no documentation repositories chosen. For GitLab, GitLab Integration no longer shows GitLab is not connected yet or Setup is not finished: no documentation projects chosen.
  • Each card you connected under Settings > Integrations shows Connected.
  • Settings > Organization > Members lists your invites under Pending Invites until they are accepted.
  • Saving custom instructions shows “Saved. It applies to sessions started from now on.”
  • Your journey appears under Journeys with a report.

Troubleshooting

Section titled “Troubleshooting”

Next

Section titled “Next”

Built on Potluck Docs, our open source template.