Description : User should be able to generate documentation in the doc section for the requested API. In this feature user will be able to generate the document by clicking on generate documentation icon given at the LHS.
Figma/Screenshot:
Acceptance criteria 1: [Generate documentation]
Given User is on doc section of the page
When User clicks on generate documentation icon for requested API
Then User should be able to generate the documentation by clicking on generate documentation icon & the response will start generating. While AI will be generating the response it will show generating.
Acceptance criteria 2: [Stop generating response]
Given Users response is being generated
When User clicks on stop icon at the RHS
Then User should be able to stop generating the response. After stopping if user wants he can give another prompt & it will work as per mentioned in AC1.
Acceptance criteria 3: [Auto Save response]
Given User generates the response
When Users response is auto saved
Then User should be able to auto save his generated response. Also, he edits his generated response then it should be auto saved.
Acceptance criteria 4: [Regenerate the code]
Given User wants to regenerate the document
When User clicks on regenerate icon
Then User should be able to click on regenerate icon given at the bottom LHS below. User can regenerate the document if he is
not satisfied with the document or wants an alternate option.
Note :
Split screen functionality will be same (vertical & horizontal).
Footer section will be fixed i.e. regenerate & stop buttons will be fixed.
Description : User should be able to generate documentation in the doc section for the requested API. In this feature user will be able to generate the document by clicking on generate documentation icon given at the LHS.
Figma/Screenshot:
Acceptance criteria 1: [Generate documentation] Given User is on doc section of the page When User clicks on generate documentation icon for requested API Then User should be able to generate the documentation by clicking on generate documentation icon & the response will start generating. While AI will be generating the response it will show generating.
Acceptance criteria 2: [Stop generating response] Given Users response is being generated When User clicks on stop icon at the RHS Then User should be able to stop generating the response. After stopping if user wants he can give another prompt & it will work as per mentioned in AC1.
Acceptance criteria 3: [Auto Save response] Given User generates the response When Users response is auto saved Then User should be able to auto save his generated response. Also, he edits his generated response then it should be auto saved.
Acceptance criteria 4: [Regenerate the code] Given User wants to regenerate the document When User clicks on regenerate icon Then User should be able to click on regenerate icon given at the bottom LHS below. User can regenerate the document if he is not satisfied with the document or wants an alternate option.
Note :