docs: make constructor options linkable #1486
Conversation
This PR changes the constructor options into headings so that people can link the relevant options. I have needed this multiple times but haven't been able to give people a link to the correct part of the page. License: MIT Signed-off-by: Alan Shaw <alan@tableflip.io>
ghost
assigned
|
Sweet! ⚡️ |
|
Will try and get a look at this later today. |
This also unifies the style in all the places where default values are different in various environments: use a comma between each environment. License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
There was a problem hiding this comment.
Looks like a nice improvement! One question inline.
I added a commit to fix a few typos and add links between options where we couldn’t before.
I worry a little that we might want deeper links to, say, libp2p.config.peerDiscovery, but I think you drew the line at the right place. The better way to solve that will probably be to actually generate API docs, which is a whole separate discussion 🙃
| | object | [defaults](https://github.com/libp2p/js-libp2p-connection-manager#create-a-connectionmanager) | | ||
|
|
||
| - `connectionManager` (object): Configure the libp2p connection manager, see the [documentation for available options](https://github.com/libp2p/js-libp2p-connection-manager#create-a-connectionmanager). | ||
| Configure the libp2p connection manager. |
There was a problem hiding this comment.
Is there a reason you dropped the link to the connection manager docs here? (https://github.com/libp2p/js-libp2p-connection-manager#create-a-connectionmanager)
There was a problem hiding this comment.
Wait, it is linked from the table above instead
3 participants
This PR changes the constructor options into headings so that people can link the relevant options. I have needed this multiple times but haven't been able to give people a link to the correct part of the page.