General Tidy Up ahead of Sharing with Elixir Community! #11
Conversation
Codecov Report
@@ Coverage Diff @@
## master #11 +/- ##
==========================================
+ Coverage 56.75% 59.09% +2.33%
==========================================
Files 11 8 -3
Lines 37 22 -15
==========================================
- Hits 21 13 -8
+ Misses 16 9 -7
Continue to review full report at Codecov.
|
…ts that answer critical questions in less than 7 seconds see: #1 (comment)
|
@nelsonic There are a few things/improvements I came across when implementing https://github.com/dwyl/alog/ that I'd like to add to this guide before we share it, as well as some answers to @RobStallion's questions in an 'FAQ'. I won't have a chance to do it before Friday though |
|
@Danwhy sweet! 🍭 |
|
@iteles in light of @Danwhy's learnings while creating https://github.com/dwyl/alog Please read the first few questions of the If you are happy with the ("beginners' mind" focussed) changes, please merge |
nelsonic
added
enhancement
There was a problem hiding this comment.
I've added a commit with some basic flow changes (commas, removing italics when they were too close together and made the reader flow difficult, etc), but I haven't added anything that's in my comments above.
Let me know if you'd like me to do that @nelsonic or just merge the PR and update later.
Thanks everyone, so informative!
README.md
Outdated
| to store your App's data makes it _much_ easier | ||
| to build the App because records are never modified, | ||
| history is preserved and can easily be referred to | ||
| i.e: you have built-in "history"/traceability, debug-ability, and usage stats! |
There was a problem hiding this comment.
This last line is the 3rd time we've said this and is repeated again in the paragraph below. Repetition definitely drives the point home and is necessary but I think the point is much better made in the paragraph below (and line 78), so I would suggest we remove this i.e line to prevent people from skipping the paragraph below when they see it is repetition (that was my instinct).
There was a problem hiding this comment.
@iteles agreed. if we can cut down the repetition it will be a really good thing!
README.md
Outdated
| People who want to improve the _reliability_ of the product they are building. | ||
| Those who want to understand more ("advanced") | ||
| "distributed" application architecture | ||
| including the ability to (optionally/incrementally) use IPFS and/or Blockchain! |
There was a problem hiding this comment.
Suggest: "(optionally/incrementally) build on this by using IPFS and/or Blockchain in the future !" to clarify tutorial doesn't cover this
There was a problem hiding this comment.
@iteles please feel free to update the README.md on this branch with this suggestion ...
| ["_Time Travelling Debugger_"](http://elm-lang.org/blog/time-travel-made-easy) | ||
| which is an _incredibly_ powerful way to understand and debug an App. | ||
| By using an Append-only Log for _all_ data stored by our Elixir/Phoenix Apps, | ||
| we get a "time-travelling debugger" and _complete_ "analytics" _built-in_! |
There was a problem hiding this comment.
I think this may be confusing for 'beginners', particularly those who have gone on to look into elm's debugger.
What we're saying is that you have all the data so you can figure all of this out from the data (and you can do this in nice ways like the last step of the readme). What a beginner may read is that you get a nice little sidebar and some form of analytics UI 'built in' which could be confusing.
There was a problem hiding this comment.
@iteles we will have a "nice sidebar" in the UI once I'm "done" with this example! 😮
iteles
added
in-review
and removed
awaiting-review
question
@iteles please review the copy changes ahead of @Danwhy's update to the "How?" section.
Thanks! ✨