Documentation Drive Week 7

[elevenpassin]

Here are a few problems that I would like to draw your attention to:

• No description, you can't really tell what the package is being used for at a first glance. (Add a small sentence briefly explaining what problem the package attempts to solve)
• Exports are not documented (name, version, manifest & init properties)
• Explain what manifest & init exports are for and what they do (in case of functions)
• defaultIds in the options property of the method ssb-server.suggest.profile(opts, cb) has a default value of an empty array. This is not specified in the documentation
• It's not clear what is happening when you register the plugin with the server.

[KyleMaas]

I would think this is pretty good now - I was able to integrate ssb-suggest into ssb-browser-core without prior knowledge of what it was or how it was supposed to be used. Can this be closed now?