Right now, the majority of our Adaptors do not have an Overview section where we describe, in simple terms, what the functional value and use case of the adaptor is. This is a missed opportunity for communicating functionality across the platform. It's also something that an LLM should be able to handle fairly easily.
This Issue is to add a dscriptive Overview to every Adaptor we have. Ideally, it will also introduce a repeatable 'prompt' that we can use to auto-generate these types of overviews in the future, which can be included as part of the Adaptor publishing process.
Good examples for the LLM to follow:
Acceptance Criteria:
Every Adaptor has a compelling Overview section which explains the value and functionality of each Adaptor, and how it might be used within solution designs to provide value to users of OpenFn.
Right now, the majority of our Adaptors do not have an Overview section where we describe, in simple terms, what the functional value and use case of the adaptor is. This is a missed opportunity for communicating functionality across the platform. It's also something that an LLM should be able to handle fairly easily.
This Issue is to add a dscriptive Overview to every Adaptor we have. Ideally, it will also introduce a repeatable 'prompt' that we can use to auto-generate these types of overviews in the future, which can be included as part of the Adaptor publishing process.
Good examples for the LLM to follow:
Acceptance Criteria:
Every Adaptor has a compelling Overview section which explains the value and functionality of each Adaptor, and how it might be used within solution designs to provide value to users of OpenFn.