Add reference documents for Docs Agent

Request access

The organization knowledge base is available on request. Contact support@ekline.io with your organization name to enable it.

Docs Agent learns your style from your existing docs, but some context lives outside your code and files: a product brief, a terminology sheet, an architecture overview, or an internal FAQ. Upload these as reference documents and the agent reads them as extra context whenever it generates or updates documentation for your organization.

Use this guide to upload a reference document, confirm the agent uses it, and manage your uploads.

Before you begin

You need:

• An EkLine account with Docs Agent enabled
• The organization knowledge base enabled for your organization

Any member of your organization can upload and manage reference documents.

Reference documents vs. a managed knowledge base

This guide covers documents you upload to give the agent context. It is different from managing a Confluence or Pylon knowledge base, where the agent reads and writes pages in an external tool.

Upload a reference document

1. Log in to your EkLine dashboard.

2. Go to Settings > Organization > Knowledge Base.

3. In the Upload Document section, drag a file onto the upload area, or click it to select a file. All file types are supported.

4. Wait for the upload to finish. EkLine processes the document and adds it to the Uploaded Documents list with a generated title and a one-line summary.

The agent uses your uploaded documents in every session your organization starts after the upload finishes. You can start the session in the editor or trigger it from a GitHub pull request, GitLab merge request, or Slack.

What to upload

Upload context the agent can’t get from reading your code or existing docs:

• Product and feature briefs. What a feature does and who it’s for.
• Terminology and glossaries. Preferred terms, product names, and definitions.
• Architecture overviews. How your systems fit together.
• Internal FAQs and support notes. Answers your team already gives customers.

Keep each document focused and current. The agent treats every uploaded document as accurate, so remove anything out of date.

Tip

Reference documents give the agent facts to draw on. To set standing rules for how the agent writes, such as spelling, voice, and terminology it must follow, use custom instructions instead. The two work together.

Manage your documents

The Uploaded Documents list shows every document available to the agent. From the list, you can:

• Preview a document to confirm you uploaded the right file.
• Delete a document you no longer want the agent to use.

Caution

Deleting a document is permanent. After you delete it, the agent stops using it in new sessions.

Verify the agent uses a document

1. Open the editor and start a new session.

2. Ask the agent a question that only your uploaded document answers. For example, "What does our onboarding service do?"

3. Confirm the answer reflects the content of your document.

If the answer doesn’t reflect your document, confirm the upload finished processing and appears in the Uploaded Documents list, then start a new session.

Troubleshooting

The Knowledge Base tab isn’t available

The organization knowledge base is granted on request. If you don’t see Settings > Organization > Knowledge Base, email support@ekline.io with your organization name to request access.

The upload fails

• Try uploading the file again.
• Upload one file at a time.
• If the error persists, contact support@ekline.io with the filename and the error message shown.

The agent doesn’t use an uploaded document

• Confirm the document appears in the Uploaded Documents list.
• Start a new session. The agent picks up new documents in sessions started after the upload finishes.

Next steps

• Customize Docs Agent for your organization: Set the conventions the agent follows in every session.
• Create documentation: Generate READMEs, API references, and guides.
• Docs Agent reference: Supported file types, limits, and FAQ.