mattgoldspink / grunt-sencha-dependencies

Grunt task to get the list of Ext.require dependencies in your application
MIT License
32 stars 22 forks source link

Confusing parts in the docs #18

Closed cburgdorf closed 11 years ago

cburgdorf commented 11 years ago

Text: "If you used Sencha Cmd and have an app.json file in your project then all you'll need to configure is the src property to point to your directory with this in. For example if you're running grunt in the same directory as your app.json it would be:"

Confusing: The src property is mentioned but in the example the property is called prod

Text: "If your index.html is in a different directory to where you are running grunt from then you'll need to set this to be relative to current directory."

Confusing: What does the "current directory" mean. It should probably read "need to set this to be relative to the directory that you run grunt from"

Text:

    grunt.initConfig({
       sencha_dependencies: {
        prod: {
          options: {
             pageRoot: './www', // relative to dir where grunt will be run
            appJs: 'app.js', // relative to www
            senchaDir: 'lib/sencha-touch-2.1.0' // relative to www
          }
        }
      }
    })

Confusing: shouldn't the appJS point to 'js/app.js' in this case?

mattgoldspink commented 11 years ago

Cheers for the feedback - I've updated all the docs now so hopefully everything is clearer, but let me know if you think things could still be better