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

Add first pass documentation #7

Open
Tracked by #39
bmtcril opened this issue Feb 9, 2023 · 0 comments
Open
Tracked by #39

Add first pass documentation #7

bmtcril opened this issue Feb 9, 2023 · 0 comments
Labels
good first issue A good task for a newcomer to start with

Comments

@bmtcril
Copy link
Contributor

bmtcril commented Feb 9, 2023

Since this is a real repo now, it should have real docs. At least:

  • Improve readme
  • Better installation and usage instructions
  • ADR 1 populated
  • Fully comment code and document why things work the way they do
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue A good task for a newcomer to start with
Projects
Data Working Group
Status: Ready for Work
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bmtcril @saraburns1