Docs Agent Discord bot
Create documentation without leaving Discord. Mention the EkLine bot in any channel or thread on a connected server, and Docs Agent replies in the same thread with a draft you can review and edit in EkLine.
Prerequisites
Section titled “Prerequisites”Before you begin, you need:
- An EkLine organization account.
- Discord server administrator access to authorize the app.
Connect your Discord server
Section titled “Connect your Discord server”-
Go to Settings > Integrations in your EkLine dashboard.
-
Find Discord in the integrations list.
-
Click Connect.
-
On the Discord page that opens, authorize EkLine to access your Discord server.
-
Select the server to connect, then complete the authorization flow. Discord returns you to EkLine.
-
Verify the integration shows as Connected.
Once connected, anyone in the server can mention the EkLine bot to start a draft in your EkLine organization.
Create documentation from Discord
Section titled “Create documentation from Discord”-
In any channel or thread on the connected server, mention the EkLine bot followed by your request.
@EkLine create a troubleshooting guide based on this discussion -
Read the acknowledgment. The bot confirms it has your request, then works on the draft. It posts no progress updates, only the finished answer.
-
Read Docs Agent’s reply in the same thread. Long answers arrive as more than one message because Discord limits the length of a single message.
Review and edit in EkLine
Section titled “Review and edit in EkLine”Each Discord mention starts a Docs Agent session in the EkLine app. Open it to review the draft, refine it, and open a pull request. To find it, filter the session list by the Discord source. See Find your sessions.
Context the bot captures
Section titled “Context the bot captures”| Context type | What the bot captures |
|---|---|
| Thread messages | Up to the last 20 messages in the thread. |
| Your request | The text of your mention, with the bot mention removed. |
Write effective prompts
Section titled “Write effective prompts”The quality of your prompt determines the quality of the output.
| Instead of… | Try… |
|---|---|
| “help with docs” | “Create a troubleshooting guide for the API timeout issue discussed here” |
| “document this” | “Write a how-to guide for the workaround Sarah described” |
| “make docs” | “Update the authentication docs based on the new flow we agreed on” |
Include specific details:
- Reference the type of documentation you need: tutorial, how-to guide, reference, troubleshooting.
- Name specific topics or features from the conversation.
- Mention existing documentation to update if applicable.
- Point to URLs or ticket IDs for more context.
Check it worked
Section titled “Check it worked”- The bot posts an acknowledgment in the thread, and later Docs Agent’s reply.
- The session appears under Sessions in the EkLine app. Filter by Source > Discord to find it.
Troubleshooting
Section titled “Troubleshooting”| Issue | Solution |
|---|---|
| Bot replies that it works inside servers connected to EkLine | You mentioned it in a direct message. Mention the bot in a channel or thread on a connected server. |
| “This server isn’t connected to EkLine” | Ask a server administrator to connect the server in Settings > Integrations. |
| “This server is connected, but its EkLine organization has no API token” | Contact support@ekline.io. |
| “I couldn’t reach EkLine just now” | Wait a moment and mention the bot again. |
| Reply arrives as several messages | Discord limits message length. Read the messages in order. |
| Draft does not match expectations | Give more specific instructions in your mention. Include the documentation type and key topics to cover. |
Next steps
Section titled “Next steps”- Docs Agent Slack bot: Create documentation drafts from Slack channels and threads.
- Find your sessions: Open, filter, and manage every Docs Agent session, including sessions started from Discord.
- Create documentation: Generate READMEs, API references, and guides from your codebase.
- Integrations: Connect Notion, Linear, Jira, and other tools.
Built on Potluck Docs, our open source template.