angular2-style-guide icon indicating copy to clipboard operation
angular2-style-guide copied to clipboard

consider using GitBook

Open Hotell opened this issue 9 years ago • 6 comments

In my experience, creating these super huge Readme files will go south sooner or later... hard to maintain, hard to refactor etc...

Consider using GitBook, all in all Dan Abramov Redux guide is really good example how things should look like IMHO.

thx

Hotell avatar Mar 01 '16 13:03 Hotell

Just did some experimentations with GitBooks. Sounds like a good idea, at some point most likely we'll switch.

mgechev avatar Mar 01 '16 14:03 mgechev

perfect, so we can close this?

Hotell avatar Mar 01 '16 14:03 Hotell

Lets keep it open as reminder :-)

mgechev avatar Mar 01 '16 14:03 mgechev

kk thx :)

Hotell avatar Mar 01 '16 14:03 Hotell

Once the guide is in a more final state, I think gitbook is a great idea.

Basarat's TypeScript gitbook is an excellent example. All that information would be tedious to read and navigate from within .md pages.

joshwiens avatar Mar 05 '16 00:03 joshwiens

@d3viant0ne :+1:

mgechev avatar Mar 06 '16 13:03 mgechev