Break Readme into GitHub-Style Documentation

microsoft / nodejs-guidelines

Tips, tricks, and resources for working with Node.js, and the start of an ongoing conversation on how we can improve the Node.js experience on Microsoft platforms.

2.49k stars 280 forks source link

Break Readme into GitHub-Style Documentation #17

Closed felixrieseberg closed 9 years ago

felixrieseberg commented 9 years ago

Using individual articles
Using relative links [readme](README.md) instead of the old absolute ones
Contribution guidelines are now in CONTRIBUTING.md, where it'll be picked up by GitHub
This setup is fairly common on GitHub (see the Electron repo as an example)

Ref #4

cc @mousetraps

felixrieseberg commented 9 years ago

@mousetraps: You can check this out in my branch. I think this would address the concern raised in #15 (as well as #4).

SteveALee commented 9 years ago

Sounds good but I could not see any obvious links to other pages/sections in the Electron readme.md

felixrieseberg commented 9 years ago

@SteveALee https://github.com/atom/electron/tree/master/docs?

SteveALee commented 9 years ago

scratch that - I see your fork and @mousetraps' work already. That's what I call a fast response :+1:

mousetraps commented 9 years ago

:+1:

I think this strikes a good balance between making content easier to navigate and not wanting to impose too much structure too soon so that we can give things a chance to evolve.

felixrieseberg commented 9 years ago

Thanks for all the feedback! I'll hit the magic button :stars:

felixrieseberg commented 9 years ago

And you're totally right, we can change everything at any time if this doesn't work for us.