git ssb

0+

happy0 / %daNEXJ4Yuh90vWnkl4O…



forked from Dominic / depject

Rendering posts example for documentation.

%C7iQBacmU2G782AkAyGAYeSa0RVbx2zJpt5AvgFx8zw=.sha256
Openhappy0 opened this issue on 2/5/2018, 11:24:56 PM

Rendering posts example for documentation.

The best use case I've seen for depject is defining different renderers for different scuttlebutt message types. Perhaps we could use this use case for the examples, with some screenshots for different message types? (likes, follows, posts, etc.)

I might have a stab at this some time this week.

%4YAAQyETD1R51kXhYcYgoVSi0eb3utFYmLapJydqHQ4=.sha256 bentflower · 2/8/2018, 9:30:35 AM

I agree that message renderers are a good concrete example that would be useful to someone coming to depject for an SSB project.

The nice thing about the existing examples (the animal noises) is that they work without tying into any other code outside of depject. I don't know if there are any projects outside of the SSB ecosystem that use depject, but I'm sure that Dominic's design was supposed to work outside of SSB.

I think we can have the advantages of both if the worked examples are SSB-inspired rather than directly using any interfaces beyond what's in depject. Maybe include a line like "Secure Scuttlebutt messages actually use a format much like this one" and "some SSB tools use depject code much like this to handle rendering". Maybe a couple of links straight to some relevant code.

%w0HYKKahDzUl1i6VGKTem2gPk0wSerQXO7Nv3a0ZWXY=.sha256 happy0 · 2/12/2018, 10:57:03 PM

Good point =]. I'll try to make it ssb inspired, rather than having to explain a bunch of ssb concepts and leak them into depject's READme =p.

I think I'm going to start with a 'menu items' example (when I next have time - already feeling guilty about not doing anything so far :P) as that's motivated as a use case for 'map' in the section above, and it's a good use case that's easy to give an example without references to external code.

%0NDiWTJtxWJbRFkSXJSdnNpOF933MgJv/No9Bw+bOxI=.sha256 mixmix · 3/7/2018, 10:29:49 PM

hey @happy0 I only just saw this. I highly recommend tagging things with channels to help people know the space you're speaking into.

to my mind this is #depject and #ssb-learning and maybe #documentation

%dVvQu28PL17fLP6AdUTi7aJgpufco5NlUdkQc3InPXs=.sha256 happy0 · 3/7/2018, 11:01:59 PM

Cheers @mix . I wasn't actually aware that posts on github issues rendered within patchwork / patchbay, which is why I didn't bother.

Built with git-ssb-web