nsabiyera / Oak

Frictionless development for ASP.NET MVC single page web apps. Prototypical and dynamic capabilities brought to C#.
http://amirrajan.github.com/Oak
MIT License
6 stars 7 forks source link

Reorganize documentation to be more friendly to newbies #45

Open eugman opened 8 years ago

eugman commented 8 years ago

The documentation is in a big pile right now and I think it could benefit from being broken up into multiple pages. I was thinking something like below, with the first level being pages and the second level being sections.

I also think it'd be good to flesh out the readme just a little bit more, even if that means a little redundancy.

I'm definitely open to feedback on this.

amirrajan commented 8 years ago

I'd like to start with the readme's that might be a good idea. The homepage has become a "big really bad list" (and not in a good way).

eugman commented 8 years ago

So are we talking bulk up the readme enough for the essentials or are we talking about having multiple .md files for documentation? If it's the latter, I'm not 100% sure how traditional projects handle that. As in, where do we want to keep those files?

amirrajan commented 8 years ago

I was thinking multiple. One readme per sample app and one at the top? Maybe a readme in every project folder so people understand what it's there for?

eugman commented 8 years ago

Ah, that works. I'll start on the pull request next week. Once I've got something going we can take a look.

amirrajan commented 8 years ago

That's awesome man. Thank you :-)