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

No descriptions/explanations for some bullets in the Overview #15

Closed
CAM-Gerlach opened this issue Apr 1, 2018 · 0 comments
Closed

Comments

@CAM-Gerlach
Copy link
Member

Issue Description

Many bullets in the Overview, as well as some sections/headers elsewhere, have no description at all. Therefore, we want to have at least a basic explanation of each before we release the docs publicly, as this is fairly low hanging fruit and will have a pretty high impact to effort ratio.

Where is the relevant portion of the documentation located?

Primarily the Overview, but content should be opportunistically added elsewhere when desperately needed and easy to do.

What would you suggest it be replaced with?

At least a few sentences/a short paragraph of explanation for each, as appropriate.

@CAM-Gerlach CAM-Gerlach added this to the Initial Public Release milestone Apr 1, 2018
@CAM-Gerlach CAM-Gerlach self-assigned this Apr 1, 2018
@CAM-Gerlach CAM-Gerlach changed the title No descriptions/explanations for many bullets in the Overview, and some elements elsewhere No descriptions/explanations for some bullets in the Overview May 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant