ssbc / dev.scuttlebutt.nz Goto Github PK

In #28 I will use mostly sbotcli examples but I think it'd be great to include both Rust & Go bindings (and potentially Python?) with concrete examples of how you wire up a client and fire requests at a sbot of some sort. You can't quite easily "curl ..." a request at a sbot (because you need secrethandshake?) so including working code examples seems important?

Does this already exist? There is a lot floating around e.g. identity vs. feed vs. ref vs. etc. etc.

Could really help people dive in.

Noticed these while browsing the site:

Given that MUXRPC is kinda a low-barrier entrypoint to working with sbots of all shapes/sizes, it'd be good to have a clear explanation of what these different types of requests are in the MUXRPC lexicon?

A new pattern is appearing, Planetary and friends are not focusing on indexing but instead streaming the log to a sqlite database for clients to make use of. What are the advantages / disadvantages of these approaches? I see a few comments criticsings the append-only paradigm but it supports specific use-case very well. It would be great to have a section on this.

History, motiviation, reasoning, needs that brought it about? Why do we do this and not REST or whatever else. I think it's especially important now that others begin to experiment with other ways to expose sbot APIs. I've seen several people mention that MUXRPC has a slight "Not Invented Here" feeling to it but I can't make a judgement without understanding the history of all that makes up MUXRPC.

Note to self: update docs to reflect the latest changes to the create_history_stream() method.

ssb_id: String -> CreateHistoryStream struct.

Hey @arj03 and @mixmix ,

It feels like this project is coming together nicely. I've recently added syntax highlighting for the Go and Rust code examples, and yesterday I read through everything and tidied up some spelling and grammar mistakes.

Do youse have any idea what you'd like to name the site?

mix has previously conceptualised this as "a map of where all the pieces are and how they fit together". So maybe Scuttlebutt Developer Map, or Scuttlebutt Tech Map, or maybe just Scuttlebutt Developer Documentation?

I can add the name to the index.html once decided up. I'm also keen on customising the homepage sidebar so it shows links for the various implementations - just so they're easier to spot at-a-glance. The rest of it all feels pretty good to me.

Are there any other changes / additions / updates you'd like to see?

I think it would be good to explain the specificities of what makes MUXRPC MUXRPC and not RPC.