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.

Sign up for GitHub

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

Jump to bottom

What makes good documentation? #24

Open
jaclyn-taroni opened this issue May 9, 2022 · 0 comments
Open

What makes good documentation? #24

jaclyn-taroni opened this issue May 9, 2022 · 0 comments
Labels
documentation Related to documentation slides/talking points Something to be covered via slides or another method that is not a hands-on exercise

Comments

@jaclyn-taroni
Copy link
Member

Breaking up #21.

We should talk about what makes good documentation using slides (or equivalent) to explore different concepts).

The scope of this issue also includes creating some bare minimum (perhaps intentionally sparse) README to be included in the repository folks fork and clone for the hands-on portion of the exercise.
@jaclyn-taroni jaclyn-taroni added documentation Related to documentation slides/talking points Something to be covered via slides or another method that is not a hands-on exercise labels May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Related to documentation slides/talking points Something to be covered via slides or another method that is not a hands-on exercise
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jaclyn-taroni