Feature/1355 docs overview

[hunterachieng]

Short Description

Add overview docs for all adaptors without this section

Closes #1355

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

• Code generation (copilot but not intellisense)
• Learning or fact checking
• Strategy / design
• Optimisation / refactoring
• Translation / spellchecking / doc gen
• Other
• I have not used AI

You can read more details in our
Responsible AI Policy

[mercy-ship-it]

Hey @jackohilts , Could you Kindly review this PR and let us know if any changes are needed?

[mercy-ship-it]

@hunterachieng You can include the Overview section for the following adaptor as they are missing in the updates

1. eapts
2. formsg
3. memento
4. motherduck
5. ona
6. postgresql

https://docs.google.com/spreadsheets/d/11cfg8dRQTOYBk27S5KUFoJEKWSYLAKzU-oYQffZboXo/edit?gid=0#gid=0

[jackohilts]

Hey I've read through the edits and I think these are all good additions, but I don't think it quite meets the Acceptance Criteria of the original 1355 Issue saying that "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."

I think this PR should still be merged, but we shouldn't close the issue just yet as we don't have good Overview Sections for all Adaptors.

One small edit I would make to the script is that add-help-section.js script doesn't check if help section already exists (which might cause duplicates if it's run twice...). Might make sense to incorporate that in a next PR if we are to automate more of this content generation.

[josephjclark]

Most information has moved to the wiki folder in the repo now. Can we link to that instead?

[josephjclark]

Or we must have a better landing page for contributions? If not we should really think about investing in something @jackohilts

[jackohilts]

Interesting @josephjclark - can you share a link to where those instructions are? Right now I take Product Team's lead on the best guidance for crowding in contributions, but I totally agree that we should invest in some clear guidance on that (starting, probably, with aligning on the process we want the big wide world to follow).

What is the best thing we have right now?

[josephjclark]

Ah classic problem of no-one owning the docs properly (and everyone having opinions)

@hunterachieng for now can you update the link to https://github.com/OpenFn/adaptors/blob/main/wiki/index.md for now

Jack and I will work out a better landing route later. But if we get that link fixed I think we can merge this for now

[hunterachieng]

@josephjclark I have fixed the links