Gh pages audit #680
Gh pages audit #680
Conversation
…ake referencing our documentation AMAZING
…. WIP on datepicker docs. Clarify overview example
… link injection script. Updated README. WIP adding ids to all h tags and converting h4 lists into dls. Moved js includes to footer out of header
| </p> | ||
| </div> | ||
|
|
||
| <p>If not present on the page onready, these controls will be 'lazily' initialized when the user interacts with them (such as on <code>mouseover</code>). <span class="text-warn">Be careful of <code>changed</code> events when initializing. To disable this data-api, use <code>$.off('fu.data-api')</code></span>.</p> |
There was a problem hiding this comment.
" this section's" and "These controls" seem ambiguous. Due to placement it makes me think it's the controls in "Requires Manual Initialization"
There was a problem hiding this comment.
Fixed. Thanks @interactivellama
| <ul> | ||
| <li>All plugins depend on jQuery <i>and</i> Bootstrap; these must be loaded <strong>before</strong> Fuel UX.</li> | ||
| <li>Version requirements for jQuery/Bootstrap are documented in our <a href="{{ site.repo }}/blob/{{ site.current_version }}/bower.json"><code>bower.json</code></a> file.</li> | ||
| <li>Check dependencies if including controls individually <span class="text-muted">(console errors will indicate unmet dependencies). Some controls depend on others.</span></li> |
There was a problem hiding this comment.
This paragraph is more helpful than the previous one. It also clarifies that these are all jQuery plugins, whereas the previous docs assumed the reader could figure this out on their own which is not good technical writing.
There was a problem hiding this comment.
Minor note, should be "Fuel UX", not "FuelUX" (eg Fuel UX is a collection of jQuery plugins.)
|
|
||
| <h5 id="pillbox-examples-sample-methods">Sample Methods</h5> | ||
| <div class="btn-group"> | ||
| <button class="btn btn-default" id="btnPillboxAdd">add</button> |
There was a problem hiding this comment.
None of these buttons appear to work.
There was a problem hiding this comment.
The pillbox sample method buttons are working in live gh pages.
|
|
This audit covers the overview and usage section for each component. The examples sections will come next (there are plans for gist driven examples with jsfiddle type tinker-boxes). Lots of work to be done yet here, but, I think this is a good stopping point for the "first pass".