Added Table of Contents to Readme.md #930
Conversation
|
You should really petition GitHub to add this, so it's automatically generated from our headers. |
|
Hmm... I don't see why this failed checks. @dougwilson, perhaps future updates could be made with doctstoc? |
|
Don't worry about the test failure; it was just a flaky test; I hit rerun on it for you just now. |
|
Can this please be merged? The docs are a pain in the ass to traverse right now. |
|
Do we know if this works on the new npm website? |
|
As an example, Bootstrap's Readme.md on github is displayed properly on their npmjs page. |
|
Right, but I mean, npm is completely different now, so just need someone (or me) to verify that all the anchor links in the pr work on the new npm. |
| - [Closing all the connections in a pool](#closing-all-the-connections-in-a-pool) | ||
| - [PoolCluster](#poolcluster) | ||
| - [PoolCluster Option](#poolcluster-option) | ||
| - [Switching users / altering connection state](#switching-users--altering-connection-state) |
There was a problem hiding this comment.
This link doesn't work on the npmjs.com site.
|
Sorry, I reverted your PR merge; I need your name and email address in order to merge your contribution. |
|
Ok. You can see the "Switching users and altering connection state" and "Piping results with Streams2" links working correctly on my practice package page. If this is ok, I'll go ahead and commit. (Aren't my github username and noreply email sufficient to merge?) Small change: I moved the Streams2 link from the "Piping results with Streams2" section heading to the single occurrence of "Streams2" in the section's text. Otherwise, the Markdown-HTML converter's avoidance of putting a link within a link leads to the section heading not rendering correctly as an anchor link (i.e., no little anchor icon appears on hover), even if you try |
|
That all sounds good. I don't know why there is a link in the header in the first place. |
|
Fixed. |
|
@jobrios unless you provide the information from #930 (comment) I won't be able to merge this as your contribution, if at all. |
|
Ok. The information is now displayed on my profile page. |
No description provided.