Docs: split API into Operations and Functions list #613
Conversation
|
I wonder how the common API fits into this. I don't want 4 lists - adaptor operations, adaptor functions, common functions, common operations. That's chaos. We can't "merge" operations and functions from common, because it's confusing. So maybe we list everything in one list, and perhaps add a* if it comes from common? |
|
One of the things with the common API is that, because it's the same for all adaptors, once you know the main common functions, they just sort of get in the way. So yes, you want to see that the common functions are there. And its critical for new users. But I do think they're second class citizens, or there should be the option to hide them, or something. |
|
I wonder if just adding a tag for Operations is a better way to go here. That still leaves namespaces to work out though... |
Summary
This PR changes the docs template so that Operations and Functions feature in two different lists.
This helps make it clear what is an Operation and what is a Plain Old Function
Details
As a bonus fix, indenting on the right hand contents menu has been fixed.
These changes do not affect the adaptor JSdoc at all. It just works out of the box.
Screenshots from a first pass:
Issues
Closes OpenFn/docs#439
Related to #522
Further work
@operationjsdoc tag, which marks the doclet public and is used to recognise operations