Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update Folder Structure for Network Participant (NP) Logs

Open
  • Is something wrong?
#398 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by inspecting the current API, Docs, and Examples directories and identify where Network Participant examples and workflows belong. Create the proposed NP Logs hierarchy with participant and workflow subdirectories, while preserving backward compatibility with existing examples. Done means the structure is organized for future participants and existing examples remain usable.

Written by the indexing model from the issue text.

Description

documentation enhancement

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.
Dominant language
No language data
Stars
453
Forks
127
No merged PRs in 30d

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from beckn/protocol-specifications

All issues in beckn/protocol-specifications

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.