Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Folder Structure for Network Participant (NP) Logs #398

Open
emmayank opened this issue Dec 21, 2023 · 0 comments
Open

Update Folder Structure for Network Participant (NP) Logs #398

emmayank opened this issue Dec 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@emmayank
Copy link
Collaborator

emmayank commented Dec 21, 2023

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.
@emmayank emmayank added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant