Skip to content
EkLine Documentation

Getting started

Create your first document with Docs Agent in under 5 minutes.

Before you begin

Section titled “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

Section titled “Open the editor”
  1. Log in to your EkLine dashboard.
  2. Click Docs Agent in the left navigation.

The editor interface has three main areas:

AreaLocationPurpose
Editor panelLeftView and edit generated documentation
Chat panelRightInteract with the AI agent
ToolbarTopView changes, switch files, create PRs

Create your first document

Section titled “Create your first document”

Generate a README for your repository:

  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. Click View Changes to see a diff of what the agent created.

  5. Click Raise PR to open a pull request with the new documentation.

You receive a link to the pull request on GitHub where you can continue the review process.

Control the agent while it works

Section titled “Control the agent while it works”

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

ButtonColorAction
SendBlueSend a new message (agent is idle)
StopRedCancel the current turn (agent is working, text field empty)
QueueAmberQueue a follow-up that sends after the current turn finishes

Click the red 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 X to cancel it.

Write better prompts

Section titled “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”

Next steps

Section titled “Next steps”