docs(state): wip documentation for state service

[0x-r4bbit]

No description provided.

[0x-r4bbit]

The new PR (@nateabele please do not merge it! :D) for work in progress API documentation.

[0x-r4bbit]

Allright @nateabele @timkindberg This is how it currently looks like http://pascalprecht.github.io/ui-router/#/api Next step would be to write a developer guide. And then improve the api docs with more examples. What do you say?

[0x-r4bbit]

BTW @nateabele you can merge these now, haha.

[timkindberg]

You are so awesome @PascalPrecht!

Some things I notice we'll still need, obviously we'll get to these, but thought it would be good to make notes while I had time.

• compat module should be last, or if we can't make it last, maybe remove it. Just gonna confuse people, I know it.
• if we do keep compat, then $routeProvider is missing docs e.g. when()
• Missing UrlMatcher docs
• Can we add versioning to each item's doc?
• How/where will we document the go and transitionTo options?

Once it's merged, I'm happy to review in depth and fix any little errors/errata.

[0x-r4bbit]

@timkindberg It's just a work in progress, so yea I'll add the docs for $routeProvider sorry for missing them. It should be clear that the docs you're seeing now are only API docs. Which means, a lot of stuff from the current wiki don't necessarily need to be in the API docs, since they would be better placed in a Developer Guide (example: http://pascalprecht.github.io/angular-translate/docs/en/#/guide). The developer guide will be more a kind of book which you can read through to understand step by step how to use UI-Router. This could also be the place to document the go and transitionTo options, but I'd prefer them in the API docs.

What do you mean with add versioning to each item doc? The API docs are versioned through source code. The developer doc will be a folder with .ngdoc files. example( https://github.com/PascalPrecht/angular-translate/tree/master/docs/content/guide/en ). These documents are (for sure) also versioned.

[0x-r4bbit]

@timkindberg btw: great you like it :)