Conversation
DlearyMW
left a comment
DlearyMW
left a comment
There was a problem hiding this comment.
In general, this all looks good. I found 1 typo, and also as I was reading and got to the first example showing window.env.API I started wondering "Did i skip over the part where that gets set?". I kept reading on and eventually got to it, but I wonder if that would be a distraction from readers coming to this documentation that aren't already familiar with it.
TL;DR: Consider switching the order of the index.html and perma bundles sections to give users an understanding of where the values are set, then later on where they are consumed in the bundles
|
@DlearyMW yeah, I have been struggling a lot with the ordering of the sections, and agree with your feedback... I feel like there are problems with talking about the |
|
I agree that there are problems with either approach. What about doing something like index.html snippet bundle.js snippet Then directly below them "Now let's break these code snippets into their respective parts in the IWA philosophy" or something like that. You give a cohesive example of the two, and then separate them in whatever order you want to describe them, but you've given the reader a concrete example so they can say "Oh that's where window.env.API comes from" if you decide to talk about the bundling first |
README.md
Outdated
| - <script src="main.js" type="text/javascript"></script> | ||
|
|
||
| + <!-- permanent, reuseable --> | ||
| + <script src="https://assets.myapp.com/apps/bae1407/main.js" type="text/javascript"></script> |
There was a problem hiding this comment.
What is bae1407?? Might be better to carry through the same example asset name/version that you refer to earlier in the doc.
There was a problem hiding this comment.
yeah, I will replace the hash in favor of a consistent three part versioned string.
|
@DlearyMW I will work on starting with an upfront example of both a service and a |
3 participants
Ok, here is a draft that I think I am willing to share with some more people to get feedback. I have been looking at it for too long, so I am not sure if it makes any sense.
I'd like to merge what is here with any minor feedback before I share it.