# Getting started with Docs Agent

import { Steps, Aside } from '@astrojs/starlight/components';

<Aside type="note" title="Beta">
  Docs Agent is in beta. Contact support@ekline.io to request access.
</Aside>

## Before you begin

You need:

- An EkLine account with Docs Agent enabled
- At least one repository connected to EkLine

Don't have access? Email **support@ekline.io** with your organization name.

## Open the editor

<Steps>
1. Log in to your [EkLine dashboard](https://ekline.io/dashboard).
2. Click **Docs Agent** in the left navigation.
</Steps>

The editor interface has three main areas:

| Area | Location | Purpose |
|------|----------|---------|
| **Editor panel** | Left | View and edit generated documentation |
| **Chat panel** | Right | Interact with the AI agent |
| **Toolbar** | Top | View changes, switch files, create PRs |

## Create your first document

Generate a README for your repository:

<Steps>
1. In the chat panel, type:
   ```
   Generate a README for this repository. Include installation
   instructions, usage examples, and contributing guidelines.
   ```

2. Wait while the agent analyzes your repository structure and code.

3. Review the generated content in the editor panel.

4. Enable **View All Changes** to see a diff of what the agent created.

5. Click **Raise PR** to open a pull request with the new documentation. The agent prefills a prompt in the chat — press **Enter** to send it, or edit the prompt first to add instructions.
</Steps>

The agent creates the pull request and responds in the chat with a link where you can continue the review process on GitHub.

## Control the agent while it works

The chat input button changes color to reflect what the agent is doing:

| State | Icon | Action |
|-------|------|--------|
| **Send** | Arrow up | Send a new message (agent is idle) |
| **Stop** | Stop | Cancel the current turn (agent is working, text field empty) |
| **Queue** | Plus | Queue a follow-up that sends after the current turn finishes |

Click the **Stop** button to cancel a turn mid-flight. Any partial work stays in the editor for you to review. To queue a follow-up, type your message while the agent works and press **Enter**. Queued messages appear with a clock icon and are delivered together when the turn completes. Click a queued message to edit it, or click the **X** icon to cancel it.

## Write better prompts

The more context you give, the better the output.

| Instead of... | Try... |
|---------------|--------|
| "Write docs" | "Create a getting started guide for Python developers" |
| "Update the README" | "Add a Docker installation section to the README" |
| "Help with API docs" | "Document the POST /users endpoint in src/api/users.ts with request and response examples" |
| "Make release notes" | "Generate release notes for tickets ENG-100 through ENG-105, grouped by Features and Fixes" |

<Aside type="tip" title="Write better prompts">
- Reference specific files: `"Look at src/api/auth.ts"`.
- Mention your framework: `"This is a Next.js project"`.
- Specify the audience: `"Write for developers new to GraphQL"`.
- Point to style examples: `"Match the tone of docs/quickstart.md"`.
</Aside>

## Next steps

- [Create documentation](/agent/create/) — Generate READMEs, API refs, and guides.
- [Update and review](/agent/update-review/) — Keep docs in sync with code changes.
- [Integrations](/agent/integrations/) — Pull content from Slack, Notion, Linear, and more.
- [Set up automated style checks](/reviewer/quickstart/) — Enforce style guides and catch quality issues on every pull request with Docs Reviewer.