Adaptor docs: Link to full documentation for a specific adaptor version
Nobody has claimed this yet.
- Dominant language
- Elixir
- Stars
- 296
- Forks
- 86
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 50
Description
In Lightning, the Docs panel shows a reference to the functions available for the adaptor you have selected. This is bound to the specific version of adaptor.
But it's not complete documentation - and there are limitations right now in its generation.
It would be super useful to link to the full documentation at the top of the docs panel, which opens a new ta.
The catch is that docs.openfn.org only has documentation for the latest release.
What we can do is link to the github tag for that adaptor version. That at least gives good access to the source, the readme, and the inline comments.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Lightning Docs panel and the adaptor version data it displays. Trace how the selected adaptor version is represented, then verify that a link can open the corresponding GitHub tag and that the link is shown at the top of the panel.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100