-
Notifications
You must be signed in to change notification settings - Fork 303
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate adapter documentation automatically #413
Comments
Adding a few notes from some research on automated API documentation:
There seems to be a lot of tools converting from OAS to other readable formats:
On a different note, this could be used for autogenerating code documentation (probably not needed for EAs, but maybe in the bootstrap?) |
Current configuration/tools: Command to run (from root):
Example in the Next tasks:
New things to consider:
|
New working branch: https://github.com/smartcontractkit/external-adapters-js/tree/feature/autogen-docs-2
For full deployment, requires changes to existing EAs to export the necessary parameters |
@austinborn is owning autogenerating documentation on separate stories now |
Keeping documentation up to date for adapters is painful, and we should be looking at how to automate this process.
The discussion on the topic started here.
The text was updated successfully, but these errors were encountered: