Docs: split API into Operations and Functions list #613
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
@operation
jsdoc tag, which marks the doclet public and is used to recognise operations