Skip to content
This repository has been archived by the owner on Feb 16, 2024. It is now read-only.

Need top level documentation for project #2

Open
JonHass opened this issue Jul 24, 2020 · 2 comments
Open

Need top level documentation for project #2

JonHass opened this issue Jul 24, 2020 · 2 comments

Comments

@JonHass
Copy link

JonHass commented Jul 24, 2020

The top level code area for this project has no documentation explaining the project goals, the directory layout, dependencies, tooling (like the openapi) available. When accessing the /nsfcac/MetricBuilder repo, there needs to be enough high level explanation for someone to understand what is in this repo, how to start to use it, and where to look for additional information.

@Artlands
Copy link
Collaborator

The top level code area for this project has no documentation explaining the project goals, the directory layout, dependencies, tooling (like the openapi) available. When accessing the /nsfcac/MetricBuilder repo, there needs to be enough high level explanation for someone to understand what is in this repo, how to start to use it, and where to look for additional information.

Thanks for the suggestion. We've reorganized the files and add README to the top-level of the repo. We will keep updating this document.

@Artlands Artlands reopened this Jul 27, 2020
@githubyongchen
Copy link

Reopen for Jon to confirm, and if resolved, then to be closed by him.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants