Write getting started article about lmd

[azproduction]

It should cover:

• 3-party modules adaptation (backbone with plugins)
• shortcuts (for global jQuery and/or bundles)
• globbing
• integration (with backbone, angular or ember.js)
• mixins (e.g. for /admin, locales or debugging)
• bundles (e.g. for config window)
• lmd-info(1)
• styles (.css and .ie.css)
• Grunt + grunt-lmd
• unit tests (mocha+chai on karma)

[rlopes]

+1 for the new detailed getting started article.

[azproduction]

@generalov can you suggest a topic for new Getting Started? Or maybe things that should be covered?

[generalov]

As a curious programmer I want to see what main task is solved by your library, and what do I need to do this. +1 for the new short and simple getting started article. ^)

These topics are very important, but they look too complicated for Getting Started article, IMHO. Does #164 is about any special sections of the documentation with recipes for advanced use cases?

[azproduction]

too complicated for Getting Started article

I can cover each of them step by step, start from mapping real FS to abstract FS.

[generalov]

When I want to say what I need "more documentation" is not always meens that I want it "more" in a volume or "more" in a scope. Rather, I want more short and more conctrete recepie to solving my current task.

I like a CommonJS module declaration style on server and I want to use them in browser too. And I too lazy to write Gruntfile to prepare such modules for using in browsers. It looks like the LMD for me. What minimum do I need to begin use it? I think this is a topic for Getting Started article and it should be short (wiki:Getting-started is too complicated, imho).

How could you library to help me more? There are another topics and LMD has a great documentation. I had once looking into the sources - to determinate the set of template variables for path substitution. Another unclear totpic was a testing and I found the answer in #129.

[rlopes]

Ultimately you could have simple getting started examples. Then you could structure the documentation using maybe the config flags table as a starting point from where for each features you get access to more demos and code examples as well as more detailed documentation for more advanced topics like async, bundles. A good chunk of the documentation is already there. Maybe it is just about reshuffling it a bit and adding more details in some cases.

I feel comfortable now with the library and the grunt-lmd task as well but documentation is critical to get people in, and it has to solve real problems as well as providing solutions for more advanced topics and real life usage: this is where I like the idea of using a melting pot of features used with popular frameworks examples like Angular and Ember to show how LMD benefit them and easily mix with their routes / controllers / views / templates. I like the idea of borrowing their own getting started or cookbook examples.

[azproduction]

@rlopes @generalov thanks! I will simplify current getting started a bit and will add some refs to detailed examples of each topic in it.

I think that the playground will help as well. With live code editor and realtime bundle compilation. What do you think?

+----------------+---------+
| index.lmd.json | main.js |
+----------+-----+---------+---------------------+
| .lmd/    | var _ = require('lodash');          |
| main.js  |                                     |
| tpl.html |                                     |
|          |                                     |
|          |                                     |
+----------+-------------------------------------+
| info:    Building  example                     | 
| info:    Writing LMD Package to                |
| info:    Build complete                        |
+------------------------------------------------+

[rlopes]

A playground sounds like a great idea indeed. For my part I am comfortable using LMD now in my current mid-sized project build with Ember.

[rulatir]

The "getting started" article should cover getting started, not a dozen of advanced topics.

By getting started I mean something like two modules named "Hello" and "World", a manifest that defines "Hello" as depending on "World", and a HTML page that succeeds at loading "World" implicitly by requiring "Hello".

[azproduction]

@rulatir there is Getting Started of 3 modules https://github.com/azproduction/lmd/wiki/Getting-started :)