OpenFn / lightning

OpenFn/Lightning ⚡️ is the newest version of the OpenFn DPG and provides a web UI to visually manage complex workflow automation projects.
https://openfn.github.io/lightning/
GNU Lesser General Public License v3.0
115 stars 31 forks source link

Provide link to `/src` from Inspector #2218

Closed taylordowns2000 closed 3 days ago

taylordowns2000 commented 3 days ago

Validation Steps

View adaptor docs for adaptors without any docs:

image

View adaptor docs for adaptors with docs:

image

Notes for the reviewer

@josephjclark , documentation is getting better every day, but in my typically workflow I still almost always go to the source. There's something nice and soothing about knowing exactly what this thing I'm about to call really is. What do you think?

Review checklist

codecov[bot] commented 3 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.68%. Comparing base (269b7d4) to head (9a1bb3d).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2218 +/- ## ======================================= Coverage 89.68% 89.68% ======================================= Files 275 275 Lines 9055 9055 ======================================= Hits 8121 8121 Misses 934 934 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

josephjclark commented 3 days ago

@taylordowns2000 how about we just ALWAYS render the "you can check the external docs HERE" line at the top of the the docs.

Then if we have docs, we'll render them, if not we'll show an error message