Skip to content

Suggestions28082012

Jump to bottom Edit New page
Timothy Chandler edited this page May 14, 2014 · 1 revision

Suggestions (28/08/2012)

X) To get started it could become helpful to include the following guides as precursor:

Create/clone a basic .git repo (through GitHub, at the same time delivers all ) adding site to virtual host (MAMP) setting up WIKI and or Forum and pointing newcomers to those additional resources Supplying the "Hello World" Guides as available, "ready to run" example

A) DOCS-Tool

Sencha JSDuck requires a webserver to run on

B) Class Reference

  1. Add missing class references.
  2. Bring existing class references up to date. (Remove deprecated references of classes, properties and methods)

C) Guides

  1. Entrance Point - Getting Started Use "Things to Understand" as introductional paragraph Complement with illustrations to get the basic concept of the framework across on one page. (ie. independent MVC triads, signaling system and other core tools, data models and stores etc.)

  2. Supply links and access to all dependencies (libraries [JSKK, jQuery, strappy]) needed to get started. (Can also link back to point X) setting up a git repo)

  3. Complete "Hello World" guide, so that at the end of the section, the developer has a working component that visually outputs "Hello World". Don't forget to show how that component is being placed into index.html

  4. Rewrite "Hello World" so it evolves through all guide sections, ideally resulting in a working mini app. (Each section builds upon its predecessor)

  5. Add information to scaffolding toolkit a. Known issues b. Python version needed c. Explicit run command d. Complete scaffolding example

D) Basic Examples

  1. Add additional comments if needed (ie. refer to naming conventions, give short introductional sentence).
  2. Improve code blocks formatting (consistent indents and colors?)
Add a custom footer
Add a custom sidebar

Clone this wiki locally