ssb-server
ssb-server copied to clipboard
TODO: document weirdness (or make weirdness go away)
in the documentation drive, @christianbundy said:
undocumented methods?: yes, .use(), but that's documented in secret-stack -- should we be documenting any methods in ssb-server?
if something is a x there should be a clear link to x, at least.
it seems like we're mostly just passing through ssb-db + plugins and secret-stack.
indeed, since version 14, ssb-server is just a bundle of plugins
I have weird feelings about ssb-server in general. It doesn't have any API of its own, but it exposes ssb-db + plugins + secret-stack, plus a CLI, and the readme has lots of Scuttlebutt-specific links that seem like a better fit for ssb-handbook IMO.
a lot of these scuttlebutt specific things are there because they are really old documentation that has been lingering around since ssb was only this repo (also see ssb-db's readme, although I tieded this up this week)
sorry, I put too many comments in. the task is: How to explain ssb-server in a way that makes sense (defined by @christianbundy not feeling weird about it)
meta-idea: come up with an exercise or three for someone new to the codebase to go through, and observe or ask for their notes when building. Fresh eyes / beginner mind help document what they think are the biggest gaps.
examples:
- write a tool to get all the friends-of-friends of your id
- write a commandline echo server using ssb
- make a game of snake etc...
These can then be added as examples which could be helpful in the future
@jedahan you should check out the #village-tracker tag in ssb, we are prototyping a system for that kind of thing.
Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?