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

[WIP] Improve readme and many scripts. #753

Merged
merged 7 commits into from
Oct 26, 2018
Merged

Conversation

kurtwheeler
Copy link
Contributor

Issue Number

#699

Purpose/Implementation Notes

This improves the readme a lot and improves a lot of our scripts to make running them easier.

This is a WIP that I think was almost done, but then I got distracted so I need to return to it to finish it up.

Types of changes

  • Documentation

Functional tests

I don't remember anymore, so I should make sure to test this again.

Checklist

  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

@kurtwheeler kurtwheeler requested a review from Miserlou October 25, 2018 20:39
@kurtwheeler
Copy link
Contributor Author

@Miserlou I've reviewed this and it looks pretty good to me. I think there's still a lot more we can improve as far as documentation goes, but this gets a lot of the worst stuff in better order. I haven't re-tested all the script changes yet, but I'll do that post-review in case there's major changes that necessitate another round of testing anyway.

For broader documentation improvements I think that we should consider coming up with an Information Architecture or something as a team so we know what topics we want need to have covered, what structure we want to use (i.e. one giant readme, multiple markdown files, a readthedocs page, etc), and what level of detail we want to cover. I'm happy to write lots of documentation, but the hardest part for me is knowing what to write about, what level of detail to write about it, and how to organize it.

@kurtwheeler kurtwheeler merged commit a759756 into dev Oct 26, 2018
@ghost ghost removed the review label Oct 26, 2018
kurtwheeler added a commit that referenced this pull request Jan 10, 2019
@wvauclain wvauclain deleted the kurtwheeler/improve-readme branch July 9, 2019 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants