SPEKTRA Edge API Documents

SPEKTRA Edge API documentations. Please read below if you need to publish your API document because the process to update the document is fully automated and done through regenerate.sh and the github action.

regenerate.sh

The API document generation is controlled by protoc-gen-edgelq-doc. Please meke sure your regenerate.sh triggers the plugin in case you want to publish the API documentation through the docs.edgelq.com.

Github Action

We utilize the create-pull-request github action to create a edgelq-docs PR through the SPEKTRA Edge releases. Create a new SPEKTRA Edge release once your API document is ready and committed to the main branch.

edgelq-docs PR

The PR will be created against edgelq-docs repository through the github action mentioned above. Here is the example for your reference.

Review and approve the PR once you double checked the deply preview as created by the netlify.