Review/Feedback/discussion/changes of the Beckn-ONIX stack document

[rajaneeshk90]

Description

This issue is created to gather review, feedback, and discussion on the Beckn-ONIX stack document. The document outlines the integration and implementation details of the Beckn protocol within the ONIX domain.

Goals

• [ ] Collect comprehensive feedback on the Beckn-ONIX stack document.
• [ ] Identify any gaps or areas of improvement in the document.
• [ ] Discuss potential enhancements and modifications.
• [ ] Ensure the document aligns with the project goals and standards.

Expected Outcome

• A revised and improved Beckn-ONIX stack document that addresses all feedback and suggestions.
• Clear understanding and agreement on the implementation details and integration points.

Acceptance Criteria

• [ ] All feedback and suggestions are documented and reviewed.
• [ ] The document is updated based on the feedback received.
• [ ] Consensus is reached on the final version of the document.

Mockups / Wireframes

NA

Product Name

Beckn

Domain

ONIX

Tech Skills Needed

• Understanding of the Beckn protocol
• Knowledge of ONIX domain
• Experience with integration and implementation of protocols
• Technical writing and documentation skills

Complexity

Medium

Category

Documentation

Sub Category

Review/Feedback

[rajaneeshk90]

Beckn-ONIX Stack documentation consisted of 12 google documents for each sections.

Upon a request from Ravi, merged all the files in one google doc. Post merging some changes were made to make the document flow consistent. Format changes were made to make the look of the document consistent.

This is the merged document: https://docs.google.com/document/d/1zvmp6WTBE35SYCzYJR-NnY9MM34vQXeVfUClNfQUrBE/edit#heading=h.m1mzlygez2v3

[rajaneeshk90]

Meeting with Faiz, Ravi was organised to review the document. Many points were suggested. MOM of the meeting:

Action Items: Create New Beckon-ONIX-Stack Documentation: Objective: Develop a new Beckon-ONIX-Stack document from the ground up, focusing exclusively on core functionalities. Core Functionalities: Must be consistent across all Beckon-ONIX distributions/SDKs. These are essential features that Beckon-ONIX cannot function without. Each core functionality must clearly state whether it is required for BAP, BPP, or both. Extended Functionalities: To be included in a future version after the core functionalities are finalized. Extended functionalities can vary between different Beckon-ONIX distributions/SDKs. The extended section should illustrate potential use cases to showcase future possibilities and drive adoption. Core Functionalities Guidelines: Definition: A functionality is deemed core if Beckon-ONIX cannot operate without it; otherwise, it is considered extended. Requirements: Include a statement for each core functionality, indicating that it is a required (MUST HAVE) feature. Example Core Functionalities: L2 configuration to also manage the registry. Beckon-ONIX must detect and adapt to new L2 configurations. The platform should support the simultaneous existence of multiple L2 configurations. Selection of an appropriate L2 configuration should be based on the request context. Add a section discussing the pros and cons of synchronous and asynchronous modes, including example use cases for webhook integration. Next Steps: Begin drafting the new document, focusing on core functionalities as outlined above. Plan the inclusion of extended functionalities after the core features are fully defined and approved.

[rajaneeshk90]

A meeting with Faiz and Venkatesh was organised as a followup to the previous review and feedback meeting. As per the action item, a new Onix stack doc was created:

https://docs.google.com/document/d/12A97OUeBNSvsnzCWOWay9FkNUdDmvwMwnvZ-JKv6IQM/edit#heading=h.m1mzlygez2v3