Browse Source

docs: explain difference between dashboard example and code, closes #1500

Renée Kooi 6 years ago
parent
commit
a9eda15c6a

+ 1 - 1
website/src/_template/contributing.md

@@ -15,7 +15,7 @@ npm run bootstrap
 
 We use lerna to manage the many plugin packages Uppy has. You should always do `npm run bootstrap` after an `npm install` to make sure lerna has installed the dependencies of each package and that the `package-lock.json` in the repository root is up to date.
 
-Our website’s examples section is also our playground, please read the [Local Previews](#Local-Previews) section to get up and running.
+Our website’s examples section is also our playground, please read the [Local Previews](#Local-previews) section to get up and running.
 
 ### Requiring files
 

+ 2 - 0
website/src/examples/dashboard/index.ejs

@@ -19,6 +19,8 @@ Dashboard is the full-featured UI for Uppy that shows nice file previews and up
 
 <p>On this page we're using the following JavaScript snippet:</p>
 
+<blockquote>Note: in this snippet we've omitted the code to toggle options using checkboxes. The behavior of this code may be different from the above example depending on which options you've selected.</blockquote>
+
 {% codeblock lang:js %}
 const Uppy = require('@uppy/core')
 const Dashboard = require('@uppy/dashboard')

+ 1 - 1
website/themes/uppy/layout/partials/generated_stargazers.ejs

@@ -1 +1 @@
-18486
+19048