Create wiki page with demo snippets

[ProLoser]

Essentially we need some up-to-date documentation, but by 'demo snippets' I'm referring to how different features and edge-cases are to be addressed.

[timkindberg]

Note: Consider pulling in pieces of our discussions. I've marked two discussions with the "doc" label to indicate that they may have useful tidbit worth stealing.

The one in particular that seems useful is @ksperling in-depth explanation of his implemenation

[jeme]

I was considering that this will properly need a range of tutorials, similar to how Ember has an extended set of pages on their routing API. We don't need to follow that same approach, but this is to complex to keep as short as the current angular tut on routing.

Something like:

• The most Simple example that aligns to what you could before in Angular. So no child/parent states, just a flat set of pages and one view.
• Starting on nested views and parent/child states.
• Digging into enter/exit

etc...

Also since the AngularUI page obviously incorporates a different type of "navigation" (it renders everything, it just scrolls down) I think it would be cool with an example implementing that but with an specific URL to each "scroll-point"... (it doesn't seem to have that now)... http://angular-ui.github.com/

Finally for tutorials, since the Core team want's to get more involved, should we try to stay close to their "formats" when creating this? (that type of documentation seems to be done directly in html and not a wiki style format like here on Github :S... ) Or do we just migrate if that gets nessesary.

[ProLoser]

Up to you guys. For now I think wiki is better because I don't have the time know knowledge to use their docs generator.

We can migrate later.

Dean Sofer
DeanSofer.com
714.900.2254

On Thursday, February 14, 2013 at 2:26 PM, Jens Melgaard wrote:

I was considering that this will properly need a range of tutorials, similar to how Ember an extended set of pages on their routing API.
Something like:
The most Simple example that aligns to what you could before in Angular. So no child/parent states, just a flat set of pages and one view.
Starting on nested views and parent/child states.
Digging into enter/exit

etc...
Also since the AngularUI page obviously incorporates a different type of "navigation" (it renders everything, it just scrolls down) I think it would be cool with an example implementing that but with an specific URL to each "scroll-point"... (it doesn't seem to have that now)... http://angular-ui.github.com/
Finally for tutorials, since the Core team want's to get more involved, should we try to stay close to their "formats" when creating this? (that type of documentation seems to be done directly in html and not a wiki style format like here on Github :S... ) Or do we just migrate if that gets nessesary.

—
Reply to this email directly or view it on GitHub (https://github.com/angular-ui/router/issues/11#issuecomment-13582382).

[ksperling]

I had a brief look at ngdoc, but it didn't seem too easy to pull out of the main Angular repository and build setup. For now I've just been using vanilla JSDoc with the markdown plugin for the documentation; at least that's reasonably close to ngdoc so shouldn't be that hard to migrate.

Any tutorial / guide type content we should probably just write in GHF Markdown

[timkindberg]

Working on something here: https://github.com/angular-ui/router/wiki/AngularUI-State-Manager-and-Router---Overview

[timkindberg]

Actually i just moved the overview to the wiki home: https://github.com/angular-ui/router/wiki

And I moved the old home to here: https://github.com/angular-ui/router/wiki/Votes-on-Router-Specs-(old)

[timkindberg]

@ksperling can you please review the In-Depth Overview and let me know what else needs to be in there? Not sure, but I've spent quite a bit of time on it and think I just need some feedback at this point. I'd like to link to the docs at various places too, but we'd need to publish the docs to gh-pages branch (which I decided I don't want to do since they'll be updated so often by you, I think you should just push them at each update (same with the example site that should be added to gh-pages))

[ksperling]

Just had a read through -- Looks great and very detailed!

I think we should rewrite the 'object-based states' sample to just use a separate var for each state rather than nesting them inside each other or in a 'states' object -- while those work they might confuse the issue a bit.

Also I'm not sure some of the view names examples are completely correct, as the relative view names are implicitly qualified with '@' rather than '@'.

For the gh-pages branch, we probably want a script that can be triggered via grunt...

[timkindberg]

Ok I'll change the object based state section.

You may have to edit the view name stuff, I'll see if I can figure out what
you mean.

I do think it would be good to have the gh-pages branch be automatically
updated whenever we build. I'm not sure how to do that though.

Thanks,
Tim

(Sent from my mobile)

On Feb 23, 2013, at 7:07 AM, Karsten Sperling notifications@github.com
wrote:

Just had a read through -- Looks great and very detailed!

I think we should rewrite the 'object-based states' sample to just use a
separate var for each state rather than nesting them inside each other or
in a 'states' object -- while those work they might confuse the issue a bit.

Also I'm not sure some of the view names examples are completely correct,
as the relative view names are implicitly qualified with '@' rather than
'@'.

For the gh-pages branch, we probably want a script that can be triggered
via grunt...

—
Reply to this email directly or view it on
GitHubhttps://github.com/angular-ui/router/issues/11#issuecomment-13989101.

[timkindberg]

Ok I updated the wiki, but I also opened a new issue in relation to named views. See issue #32.

[timkindberg]

Closing this