Create Implementation Guide for Open Belem Project

[viraj89]

Description

Now that we have a template starter kit and implementation guide, the following has been decided:

1. The Missions team will create and maintain the implementation guide for each mission.
2. The implementation guide will be stored in this repository.
3. The only input for the implementation guide from outside will be the outcome visualization.
4. The implementation guide will have the following sections: a. Outcome visualization (received from the Program management team) b. Flow diagram c. API details d. Taxonomy and any Layer 2 rules e. General instructions for Seeker and Provider Platform implementers (this will mostly be common for all missions) f. Attachments (Postman collection and Layer 2 configuration file)

Following this approach, create the implementation guide for the Open Belem project and share it on the Confluence Page here.

1. The Implementation Guide for UEI can be referred to here. (Ticket #85)

2. UEI Outcome Visualization on Confluence is available here.

3. Example JSONs from Confluence can be found here.

Goals

• [ ] Develop and maintain the Open Belem implementation guide.
• [ ] Ensure all necessary sections are included and documented.
• [ ] Store the implementation guide in the specified repository.

Expected Outcome

• A comprehensive Open Belem implementation guide is created and stored in the repository.
• The guide includes all required sections and is ready for use by mission teams and implementers.

Acceptance Criteria

• [ ] Implementation guide includes outcome visualization, flow diagram, API details, taxonomy, Layer 2 rules, and general instructions.
• [ ] Attachments (Postman collection and Layer 2 configuration file) are included.
• [ ] Implementation guide is reviewed and approved by relevant stakeholders.

Mockups / Wireframes

NA

Product Name

Beckn

Domain

Open Belem

Tech Skills Needed

Documentation, API Design, Process Flow

Complexity

High

Category

Documentation

Sub Category

Implementation Guide

[rajaneeshk90]

Have not been able to devote time on this. We had to prioritise IGM, Open Source Contributions and HyperBeckn tasks.