readme: add docs #3
Conversation
Fishrock123
force-pushed
the
readme-docs
branch
from
a07f686
to
8fcb060
Compare
| @@ -8,42 +8,280 @@ | |||
|
|
|||
| Simple middleware-style router | |||
|
|
|||
| ## Installation | |||
| ### Installation | |||
There was a problem hiding this comment.
You cannot establish a h3 when no h2 even exists; please make these make sense from a hierarchy instead of how GitHub happens to make them look.
There was a problem hiding this comment.
Quite frankly I care much more about ease of reading.
There was a problem hiding this comment.
WTF? The difference is between 1.75em and 1.5em and would allow us to use a TOC generator if it's kept right.
There was a problem hiding this comment.
I work in front-end and with design everyday, these things bug me. :P
I don't understand why this would be in the TOC, or where we would put a full(?) TOC?
Besides this is regular html stuff, shouldn't a generator be able to handle this?
There was a problem hiding this comment.
GitHub may be adding an automatic TOC soon. It doesn't skip anything. I have no idea how it will work if you skip levels, perhaps by precluding us the ability to use it?
There was a problem hiding this comment.
Bu yea, if you want it to be level 3, we need to move it under an existing level 2, or maybe just remove the installation section all together, since we don't think it fits in it's current location by changing the level.
There was a problem hiding this comment.
Skipping levels isn't uncommon. iirc there's nothing unsemantic about it in markdown.
There was a problem hiding this comment.
Just remove the section, move it, or put it back to level 2 is all I'm saying.
Markdown spec at https://daringfireball.net/projects/markdown/basics makes it 100% clear that directly map to HTML header levels and the HTML spec http://www.w3.org/TR/html401/struct/global.html#h-7.5.5 mentions that people believe skipping is a bad practice, as it should be, since HTML does not represent styling, but document structure.
|
Note to self: this does not cover error handling middleware. |
Fishrock123
force-pushed
the
readme-docs
branch
from
8fcb060
to
a0b8ba6
Compare
|
@dougwilson unless you have other comments I'd like to merge this tonight and then open issues for the other two things. |
Fishrock123
force-pushed
the
readme-docs
branch
from
a0b8ba6
to
43a7da0
Compare
Fishrock123
force-pushed
the
readme-docs
branch
from
43a7da0
to
e584500
Compare
Fishrock123
force-pushed
the
readme-docs
branch
from
e584500
to
f935d46
Compare
|
@dougwilson ok landing if LGTY |
|
|
||
| var router = new Router() | ||
| The [http methods](https://github.com/visionmedia/node-methods/blob/master/index.js) provide the routing functionality in `router`. |
There was a problem hiding this comment.
Update this link for the new org name.
Fishrock123
force-pushed
the
readme-docs
branch
from
f935d46
to
00db073
Compare
Fishrock123
force-pushed
the
readme-docs
branch
from
00db073
to
28ca2ef
Compare
|
@dougwilson fixed up most of the things, I think. Except the weird wording on the description. |
|
@Fishrock123 nice!!! |
| - [.route()](https://github.com/pillarjs/router#routerroutepath) | ||
| - [__Route()__](https://github.com/pillarjs/router#routerroutepath-1) | ||
| - [`.{http method}()](https://github.com/pillarjs/router#routehttp-methodhandler) `.get() / .post() / etc` | ||
| - [.all()](https://github.com/pillarjs/router#routeallhandler) |
There was a problem hiding this comment.
hm. I didn't realize these where links to GitHub; they don't work on the GItHub mobile website.
Continued from #2
cc @rlidwka