beckn / beckn/DSEP-Specification

Enhance README with Folder Descriptions

Open
#168 1 comment 0 reactions 1 assignee Claimed by @faizmagic View on GitHub
documentation enhancement
Dominant language
No language data
Stars
21
Forks
20
PR merge metrics
No merged PRs in 30d

Description

### Description:
We would like to improve the clarity and transparency of our repository by adding a small section to the README file that provides descriptions for the different high-level folders present. This will help users understand where to find specific information within the repository.

### Required Changes:

----------------
## Repository Directory
Below are the details about the different high-level folders present in the repository and content they have.

### 1. NP Logs
**Description:** Contains Network Participant's logs aimed at enhancing spec governance, compliance, and transparency. Explore this folder to gain insights into the implementation from network participants.

### 2. api
**Description:** Contains domain-specific API specifications in YAML format. This folder also includes a submodule that points to a particular version of the core specification. Developers and contributors can refer to this section for comprehensive API details and the underlying core specifications.

### 3. docs
**Description:** This folder serves as a documentation hub, covering various aspects of our project. It includes an introduction to the domain, related terminology, details about the project's scope and out-of-scope elements, implementation guides, and assets used across these documents. Users can refer to this section for a holistic understanding of our project.

### 4. example
**Description:** Contains JSON examples of all the APIs, including but not limited to search, select, init, confirm, etc. Each sub-domain is represented with its respective API examples. Developers can use these examples as templates or references when implementing specific features, ensuring consistency and accuracy across the project.

----------------

### Expected Outcome:
Users visiting our repository should have a clear understanding of the purpose and contents of each folder, making it easier for them to locate the information they are seeking.

## Additional Notes:
Feel free to contribute to this issue with any suggestions or improvements on how we can enhance the folder descriptions for better user navigation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.