From b0afea75c0f7b824cecad3ef3abdbcfc61d32062 Mon Sep 17 00:00:00 2001 From: hagen-danswer Date: Mon, 2 Dec 2024 11:04:35 -0800 Subject: [PATCH] updated docs --- backend/danswer/connectors/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/backend/danswer/connectors/README.md b/backend/danswer/connectors/README.md index a60421da559..9f799d08de3 100644 --- a/backend/danswer/connectors/README.md +++ b/backend/danswer/connectors/README.md @@ -31,9 +31,11 @@ Refer to [interfaces.py](https://github.com/danswer-ai/danswer/blob/main/backend and this first contributor created Pull Request for a new connector (Shoutout to Dan Brown): [Reference Pull Request](https://github.com/danswer-ai/danswer/pull/139) -For Slim Connectors, refer to this PR for an example of adding a slim connector interface to an existing connector as well as the tests: +For implementing a Slim Connector, refer to the comments in this PR: [Slim Connector PR](https://github.com/danswer-ai/danswer/pull/3303/files) +All new connectors should have tests added to the `backend/tests/daily/connectors` directory. Refer to the above PR for an example of adding tests for a new connector. + #### Implementing the new Connector The connector must subclass one or more of LoadConnector, PollConnector, SlimConnector, or EventConnector.