Design goals

website/themes/uppy/layout/partials/design_goals.ejs → DESIGNGOALS.md

@@ -8,3 +8,5 @@
  - Works great on mobile
  - Small core, modular plugin architecture for everything: (modal / dragdrop / themes/ webcam / google drive / dropbox / etc)
  - Offering sugared shortcuts for novice users (presets)
+
+ 

README.md

@@ -33,7 +33,7 @@ Content is written in Markdown and located in `./website/src`. Pull requests wel
   
 > The website is currently a clone of Yuxi Evan You's [Vue.js](http://vuejs.org/) website ([view license](website/LICENSE)) - just so we can hit the ground rolling in terms of setting up Haxo etc. Obviously as soon as possible, we should start rolling out our own layout & content.
 
-`./website/update.js` is called during website builds to inject the Uppy versions & filesizes into the documentation.
+`./website/update.js` is called during website builds to inject the Uppy versions & filesizes into the documentation. `website` in an independent folder and so it cannot rely on anything from the root project, without `update.js` explicitly making it available (copying).
 
 It's recommended to exclude `./website/public/` from your editor if you want efficient searches.
 

website/src/guide/overview.md

@@ -31,7 +31,7 @@ var exampleData = {
   name: 'Uppy'
 }
 
-// create a Uppy instance, or, a "ViewModel"
+// create an Uppy instance, or, a "ViewModel"
 // which links the View and the Model
 var exampleVM = new Uppy({
   el: '#example-1',

website/themes/uppy/layout/index.ejs

@@ -97,7 +97,7 @@
   <div class="feats">
     <div class="feat">
       <h2><span class="icon simple"></span>Simple</h2>
-      <p>Write some HTML, grab some JSON, create a Uppy instance, that's it.</p>
+      <p>Write some HTML, grab some JSON, create an Uppy instance, that's it.</p>
     </div>
     <div class="feat">
       <h2><span class="icon powerful"></span>Reactive</h2>
@@ -121,9 +121,9 @@
     </div>
   </div>
 </div>
-<div id="designgoals">
+<div id="design_goals">
   <h2>Design Goals:</h2>
-  <%- markdown(partial('partials/design_goals')) %>
+  <%- partial('partials/DESIGNGOALS') %>
 </div>
 <div id="footer">
   <a class="start" href="/guide/index.html">Get Started</a>

website/themes/uppy/layout/partials/DESIGNGOALS.md

@@ -0,0 +1,12 @@
+ - Support for IE10+?? (decide what our entry level IE is, it's okay to have a cut-off if that results in a more focused higher quality codebase. older browsers will need to opt for our jquery-sdk)
+ - Lightweight / easy on dependencies
+ - tus.io enabled
+ - ES6
+ - Robust (retries / resumes for *all the things*), avoid showing 'weird errors'
+ - Themable UI with a beautiful default
+ - Compatible with React (Native)
+ - Works great on mobile
+ - Small core, modular plugin architecture for everything: (modal / dragdrop / themes/ webcam / google drive / dropbox / etc)
+ - Offering sugared shortcuts for novice users (presets)
+
+ 

website/themes/uppy/source/css/index.styl

@@ -191,7 +191,7 @@ html, body
         &.module
             background-position -200px 0
 
-#designgoals
+#design_goals
     padding 4em 0
     background-color $green
     color #fff
@@ -203,7 +203,7 @@ html, body
     ul
         line-height 1.8em
         font-size 1.15em
-        width 320px
+        width 640px
         margin 0 auto
         padding 0
         list-style-type none
@@ -302,7 +302,7 @@ html, body
         font-size 14px
         margin .8em 0
         width 250px
-    #designgoals
+    #design_goals
         ul
             width 280px
             font-size 1.1em

website/themes/uppy/source/js/vue.js

@@ -1575,7 +1575,7 @@
 
   strats.data = function (parentVal, childVal, vm) {
     if (!vm) {
-      // in a Uppy.extend merge, both should be functions
+      // in an Uppy.extend merge, both should be functions
       if (!childVal) {
         return parentVal;
       }
@@ -4446,7 +4446,7 @@
   }
 
   /**
-   * Call attach hook for a Uppy instance.
+   * Call attach hook for an Uppy instance.
    *
    * @param {Uppy} child
    */
@@ -4472,7 +4472,7 @@
   }
 
   /**
-   * Call detach hook for a Uppy instance.
+   * Call detach hook for an Uppy instance.
    *
    * @param {Uppy} child
    */

website/update.js

@@ -1,9 +1,11 @@
-var fs = require('fs')
-var version = require('../package.json').version
+var fs            = require('fs')
+var version       = require('../package.json').version
 var themeconfPath = 'themes/uppy/_config.yml'
-var installPath = 'src/guide/installation.md'
-var themeconfig = fs.readFileSync(themeconfPath, 'utf-8')
-var installation = fs.readFileSync(installPath, 'utf-8')
+var installPath   = 'src/guide/installation.md'
+var themeconfig   = fs.readFileSync(themeconfPath, 'utf-8')
+var installation  = fs.readFileSync(installPath, 'utf-8')
+
+fs.writeFileSync('themes/uppy/layout/partials/DESIGNGOALS.md', fs.readFileSync('../DESIGNGOALS.md', 'utf-8'));
 
 fs.writeFileSync(
   themeconfPath,