beckn / beckn/logistics

Update Folder Structure for Network Participant (NP) Logs

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

**Issue Details:**

#### Problem Statement:
The current folder structure lacks organization for Network Participant's implemented examples, making it challenging to manage and locate specific workflows implemented by NPs.

#### Proposed Solution:
Update the folder structure to include a dedicated "NP Logs" directory, with subdirectories for each Network Participant. Each NP directory should contain subdirectories for specific workflows (e.g., search, select).

#### Benefits:
- Improved organization and clarity for NP examples.
- Simplified navigation and maintenance of NP-related workflows.
- **Improved Collaboration:** Any new Network Participant (NP) joining the project will have ready-made references available on how other NPs have implemented specific use cases.
- **Enhanced Documentation:** Documenting the logs will contribute to better spec governance, compliance, and transparency. It will also serve as a valuable resource for building test cases for Network Validation.
- **Knowledge Transfer and Training**: The documented logs can be utilized for training AI models in the future, aiding in the generation of use-case-specific JSONs. This promotes knowledge transfer and ensures a valuable resource for future development.

### Current Folder Structure:
- API
- Docs
- Examples

### Proposed Folder Structure:
- API
- Docs
- Examples
- NP Logs
- Network Participant Name
- search
- select


**Additional Information:**
- Consideration for future NPs can be made by creating subdirectories accordingly.
- Ensure backward compatibility with existing examples during the migration.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the repository root and the existing API, Docs, and Examples directories to identify how examples are organized. Create the proposed NP Logs structure with participant and workflow subdirectories, while preserving existing examples; confirm that the resulting layout matches the issue’s hierarchy and does not break current paths.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.