doc: replace OPEA_API word doc with rst version #94
Conversation
dbkinder
requested review from
chensuyue,
ftian1,
mkbhanda,
preethivenkatesh,
chickenrae and
tomlenth
as code owners
* The word (.docx) version of the OPEA API specification was stored in the docs repo and wasn't convenient for developers to read or maintain. Convert the word doc to reST. Note though this is a conversion that maintains some technical errors found during the transcription. The intention is to make this API spec more visible and able to be reviewed and updated easily in this reST form. * Create a more easily found document structure for this and other developer guides (previously in the community area) and move a few around to fit into this new navigation structure. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
There was a problem hiding this comment.
I am ok with such change. In the future, we may need something like this https://huggingface.github.io/text-generation-inference/, which is rendered from a json file https://huggingface.github.io/text-generation-inference/openapi.json.
Do we have such a JSON file for OPEA's API? |
no yet |
* The word (.docx) version of the OPEA API specification was stored in the docs repo and wasn't convenient for developers to read or maintain. Convert the word doc to reST. Note though this is a conversion that maintains some technical errors found during the transcription. The intention is to make this API spec more visible and able to be reviewed and updated easily in this reST form. * Create a more easily found document structure for this and other developer guides (previously in the community area) and move a few around to fit into this new navigation structure. Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Tom Lenth <tom.f.lenth@intel.com>
The word (.docx) version of the OPEA API specification was stored in the docs repo and wasn't convenient for developers to read or maintain. Convert the word doc to reST. Note though this is a conversion that maintains some technical errors found during the transcription. The intention is to make this API spec more visible and able to be reviewed and updated easily in this reST form.
Create a more easily found document structure for this and other developer guides (previously in the community area) and move a few around to fit into this new navigation structure.