Refactor docs for EAEE #403
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I see that you haven't updated any CHANGELOG files. Would it make sense to do so? |
|
ToDo list for adapters:
Lower Priority
|
aalu1418
force-pushed
the
refactor/EAEE-adapter-docs
branch
from
ab62f14
to
0fb3082
Compare
aalu1418
force-pushed
the
refactor/EAEE-adapter-docs
branch
from
0fb3082
to
2fc67f9
Compare
krebernisak
approved these changes
Apr 2, 2021
There was a problem hiding this comment.
Thanks, @aalu1418! Looks great :)
For the next step on the topic of docs and API in general, we should think about exposing descriptive config & input/response info directly from the adapters, and potentially generate docs similar to this automatically. An adapter could expose
JSON data where everything is explained and which we can use to generate docs.
But, we should probably look to use already available tools, and for example, generate Swagger specification.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updating README docs for various adapters for consistent layout and information structure