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

Enhance README with Folder Descriptions #168

Open
emmayank opened this issue Jan 5, 2024 · 0 comments
Open

Enhance README with Folder Descriptions #168

emmayank opened this issue Jan 5, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@emmayank
Copy link
Collaborator

emmayank commented Jan 5, 2024

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.

@emmayank emmayank added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 5, 2024
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

2 participants