Add documentation on classes / models

[tmaier]

It would be great to have some code-level comments to explain a bit the architecture.

For example what the purpose of certain classes. For example, why is there a Session model.

This could help to understand the chosen architecture and helps a future developer to pick this up more quickly.

[lazaronixon]

That's a good idea. I would like to have some comments, like in the rails scaffold. Can you submit something?

[drewhoffer]

Don't mind taking a swing at a couple as I go through with building my app and adding as I come across. Can you give me an example of where to start for doing this @lazaronixon as well as what format you would like to see?

[lazaronixon]

I didn't make up my mind about this. But some topics to consider:

• Take inspiration on rails scaffolds.
• Comments in the controllers for sure.
• I wonder if we should document models. I would have to see what it looks like first.
• Only document the default generator (without options) and --api.
• Reference methods that are not so common to the API rails documentation. so people can learn more.

[drewhoffer]

I will take a look this week and put some PR's up after work.