-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Tidy up Tests and Provide Documentation #2869
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
Conversation
|
There are already docs in the pipes which can be found here 🙈 |
|
Ah my bad, had missed the docs - discussion on discord last night indicated a few people weren't aware of how to run the tests. Feel free to ignore that commit then. 🤦 |
psychedelicious
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noted a couple small spelling mistakes and converted in the web section.
lstein
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me and I very much appreciate the doc enhancements.
The two docs are actually quite complementary, and I note that the @mauwii, am I correct in thinking that the mkdocs site always reflects the latest release? If this plan is acceptable, we should aim to get this done by the end of the week. |
psychedelicious
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My requested changes were addressed, thanks!
|
@lstein Aside from addressing conflicts, anything needed to merge this in? |
Bit of basic housekeeping and documentation to explain to people how to get local development environment running (including the tests).