Work in the editor
The editor is where you give the Docs Agent or the Marketing Agent a task, review what it drafts, and send the result on.
Before you begin
Section titled “Before you begin”-
Start a session. Click New session at the top of the sidebar. If a menu opens, select Docs Agent or Marketing Agent. The menu appears only on the Home tab of an organization with both agents; otherwise the button opens the agent directly.
You can also type into Start a conversation on the Dashboard. If you have both agents, select Docs or Marketing there first.
-
Describe the work. For the Docs Agent, type the request, for example
Add a section on webhook retries to docs/webhooks.md. The Marketing Agent opens on What are we making?: select a format, fill in the brief, and click Create draft. See Marketing Agent. -
Review the drafts. See Review changes.
-
Send the result on. See Send the result on.
To return to an earlier session, see Find a past session.
What the editor shows
Section titled “What the editor shows”Until the agent writes a file, the chat fills the page. Then the editor panel opens on the left, with one tab per file, and the chat moves to the right. The Home, Docs, and Marketing tabs above the Sessions list appear when your organization has both agents.
Once files exist, shortcuts under the chat box, such as Fact Checker for the Docs Agent or Claims check for the Marketing Agent, add a ready-made request to the box without sending it. Select text in a draft that is not in review and it is attached to your next message, so you can ask about that passage.
Review changes
Section titled “Review changes”When a turn changes a file that already existed, the file opens in review. A Reviewing changes banner offers Accept All and Reject All, and each change has its own check mark (Accept change) and cross (Reject change). A file the agent created from nothing opens ready to edit.
Edit drafts directly; your edits save automatically. In the Docs Agent, switch on View All Changes to see every change in the session against the repository.
Send the result on
Section titled “Send the result on”| Agent | Control | What it does |
|---|---|---|
| Docs Agent | Raise PR | Fills the chat box with Open a pull request. Press Enter, or add instructions first. Grayed out with “No changes to create a PR” until the session has changes. |
| Docs Agent | View PR #N | Replaces Raise PR once the pull request is open. A badge shows Open, Draft, Closed, or Merged. |
| Docs Agent | Update PR | Appears when the session has changes the open pull request does not, and no file is in review. Fills the chat box with a request to push them. |
| Docs Agent | Update KB | Replaces Raise PR for drafts in a connected knowledge base, and publishes the edits back to it. |
| Docs Agent | Linked PRs | Replaces the single button when a session changes several repositories, with an action for each. |
| Marketing Agent | Copy | Copies the open draft. |
| Marketing Agent | Download | Saves Markdown, or HTML from the arrow beside it. Several drafts, or drafts with images, download as one ZIP file. |
The Marketing Agent has no Raise PR: to put a draft in a documentation repository, ask it in the chat. For what a Docs Agent pull request contains, see How EkLine opens pull requests.
Control the agent while it works
Section titled “Control the agent while it works”| Button | When | What it does |
|---|---|---|
| Send | The agent is idle | Sends your message. |
| Stop | The agent is working and the box is empty | Stops the current turn. |
| Queue | The agent is working and you have typed a message | Holds the message until the turn ends. |
A queued message shows Queued · click to edit. Click it to edit, or its cross to cancel. When the turn ends, queued messages are sent together.
Watch the agent browse
Section titled “Watch the agent browse”When the agent opens a browser, for example to capture a screenshot, a read-only panel opens at the bottom right. Its header reads Live browser while the agent browses and Recording when the panel replays the session afterward. You can move, resize, hide, or close it. To let the agent reach pages behind a sign-in, set up a Sandbox.
Check it worked
Section titled “Check it worked”- Your session appears under Sessions in the sidebar.
- In a Docs Agent session, the toolbar shows View PR #N after the agent opens the pull request.
Troubleshooting
Section titled “Troubleshooting”| Problem | What to do |
|---|---|
| The sidebar has no New session button | Your organization has the Marketing Agent but not the Docs Agent. Click Marketing Agent in the sidebar. |
| Update PR does not appear after you edit | A file is still in review. Accept or reject its changes first. |
Built on Potluck Docs, our open source template.