Create documentation for the Beckn-Onix-Stack - Githubissues

beckn / beckn-onix-stack

Specification Design for Beckn Onix

MIT License

0 stars 1 forks source link

Create documentation for the Beckn-Onix-Stack #7

Open rajaneeshk90 opened 4 months ago

rajaneeshk90 commented 4 months ago

Started adding the documentation in google docs: https://drive.google.com/drive/u/3/folders/1_-iSiGa7xkJ8AFdSxRbMbz-5QxGKOqY1

Needed to convert the .md format to .doc manually as, the convertors or GPT were not converting correctly.

8H

rajaneeshk90 commented 3 months ago

Updates:

Creating the documentation for the beckn-onix-stack
updated the key digital functionalities
updated the cross-cutting requirements
updated the functional requirements
formatted the data structures chapter tables
formatting the docs
changing the language

12H

rajaneeshk90 commented 3 months ago

compare the Beckn-Onix data structures to make sure that they are compatible with beckn core spec version 1.1.0

rajaneeshk90 commented 3 months ago

Updated the OpenAPI yaml with the relevant APIs.
Explored options to host it somewhere on the cloud so that the service APIs can be publicly accessed.
Explored: Redocly, SwaggerHub, gitbook etc
Tried hosting on SwaggerHub
Added description at the tag level.

rajaneeshk90 commented 3 months ago

9th.

After a discussion with Ravi, it was planned that we will release stack docs in phases.
It was suggested that in the first version we include all the functionalities that are present in the current version of Beckn-Onix.
Had a call with Venkatesh to understand the features of the current versions of the Beckn-Onix.
Created a copy of the original docs to cover the things that are going to be in the first version of the Beckn-Onix-Stack documentation.
Changing the languages to meet the Beckn-Onix use case.

rajaneeshk90 commented 3 months ago

Creating Sequence diagram for the all the workflows in the beckn-onix-stack

rajaneeshk90 commented 3 months ago

15th

Made changes in the sequence diagram. Made adjustments in the functional requirement docs. Made changes in the APIs.

rajaneeshk90 commented 3 months ago

18th

Made changes suggested by Ravi after his review on 17th. reverted the changes made in the service APIs stress tested on how the catalog/ and inventory/ apis might be used.