Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TODO: document weirdness (or make weirdness go away) #646

Open
dominictarr opened this issue Mar 13, 2019 · 4 comments
Open

TODO: document weirdness (or make weirdness go away) #646

dominictarr opened this issue Mar 13, 2019 · 4 comments

Comments

@dominictarr
Copy link
Contributor

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)

@dominictarr
Copy link
Contributor Author

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)

@jedahan
Copy link

jedahan commented Mar 13, 2019

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

@dominictarr
Copy link
Contributor Author

@jedahan you should check out the #village-tracker tag in ssb, we are prototyping a system for that kind of thing.

@christianbundy christianbundy removed their assignment Jan 31, 2021
@stale
Copy link

stale bot commented Jun 2, 2021

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

@stale stale bot added the stale label Jun 2, 2021
@staltz staltz removed the stale label Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants