Hey all, I gave this repo a spin to see how to navigate around, where it's easy and where it may be tricky even with a decent knowledge of related technology. Here are some thoughts:
- Is there a need to having the two READMEs? I would prefer md only unless the notebook will be executable and set me up for the reports.
- Can the prereqs be clearer on what's required v. recommended? I'll offer a PR about it.
- What's up with the section on Augur database configuration? As a new user, I neither have an Augur db running yet, nor understand where I am in the flow. Consider adding this section to somewhere where you can assume the reader has their own Augur instance up and running.
- Could you add a md area giving a brief annotation to the boilerplate? There are a ton of imports and db things going on that it is okay are out of scope, but it's unclear when navigating directly to a notebook.
That's a first look - this issue can be closed whenever the maintainers feel they understand the feedback. Thanks!
Hey all, I gave this repo a spin to see how to navigate around, where it's easy and where it may be tricky even with a decent knowledge of related technology. Here are some thoughts:
That's a first look - this issue can be closed whenever the maintainers feel they understand the feedback. Thanks!