Skip to content

Standardize README across integrations #2104

@anakin87

Description

@anakin87

Currently, the README.md files of core integrations are quite varied: some contain documentation of the integration, while some others specify information needed to contribute.

We want to make them uniform.

  • Link the corresponding integration page on https://haystack.deepset.ai/integrations (no docs)
  • Think if some contribution info specific for that integration is helpful, e.g. the API keys needed, the Docker containers you should spin up... Maybe yes, in addition to a link to the general contribution guidelines for core integrations.

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions