MORE docs + tests

[mixmix]

I'm trying to learn how to configure ssb-server. I was pointed here to learn about connections. I found the docs confusing, and I also noticed the tests were pretty lacking.

This is a stab at an improvement:

1. added tests

• [x] try starting a server with the config generated!
  • :fire: THESE TESTS ARE FAILING RIGHT NOW :cry: (good to know!)

:rocket: In the future I want to come back and write a JSON-schema for this config bizo - this currently just feels like it's waiting to catch on fire because there are so many place you can stick something wrong

2. clearer documentation

I got confused reading these docs. And I was confused last time I looked. Finding out what's valid config is hard because this config plugs into a big turtle-stack, and I have no idea what's consuming what from here.

• [x] example which shows hot to use module with ssb-server
• [x] clearly listed all options I saw mentioned
  • I don't know what the different thing are so there are big TODOs in empty spots
  • the structure may not make sense! please change it

[mixmix]

So I'm super excited to get this merged. Shall I merge it as-is (with all the TODO stubs)?

I'd be super excited if the people who wrote or know what those fields unknown to me would fill them in, even with just a little detail... pretty much anything is better than an empty TODO right?

[dominictarr]

the documentation and tests PR is a very rare breed and highly prized by collectors. thank you @mixmix for this wonderful specimen!

[dominictarr]

merged into 2.3.8

[mixmix]

thanks @dominictarr - yeah I guess you missed this https://github.com/ssbc/ssb-config/pull/28#discussion_r245874261 where I declared I might be doing something naughty.

I'll chase the problem down and see if I can fix it

[mixmix]

Cool, I see you fixed it in 2.3.9

I'm gonna see if I can restore that code and fix ssb-server

[mixmix]

ech ... ssb-server master is failing node test/bin.js even if I downgrade ssb-config to 2.3.7 ... what's going on ):