ELI5 Documentation project

[djfnd]

[hold to fill out with setup & description]

[djfnd]

@oakgroupworldwide / estmcmxci previously posted in the depreciated discord chat:

Hey, so I think the Neume Protocol is a WIP; I think the best thing to do is to create an architecture diagram first so we can visualize what it looks like and how it works. Then we can articulate that diagram in writing. What do you think @djfnd ? We can use excalibur to help and then the benchmarks you mentioned before including the metalabel walkthrough and also this neat doc i found off the PA site. https://docs.public---assembly.com/

[djfnd]

I started a little re-design on excalidraw: https://link.excalidraw.com/l/3zCU7mS2gw0/7rleTYbcwWt

Some questions @il3ven :

• Is it correct to still call out "extract & transform" within the strategies, as a single file?
• Am I right to rename the "extraction worker" to "crawler"?
• I changed the data sources from the previous diagram, as to my understanding we aren't running from a full node, is that correct, or not? There's probably a more accurate way to state this rather than "ethereum" and "polygon"
  • We should probably also include the network syncing element here too
• Are the front ends pulling from the "embedded database" now? In the previous diagram we had arrows through "cli" and "api" up to them

Once we get this locked down then I will think about how we can make the diagram dynamic, so that a user can click on any of the segments and be sent straight through to the respective repo.

cc: @oakgroupworldwide

[djfnd]

I created an iframe embeddable link here:

<iframe src="https://link.excalidraw.com/readonly/bIUEudeoxpsjh3T8bwaD" width="100%" height="100%" style="border: none;"></iframe> . Question, I tried testing by changing the previous static image with this iframe link, but it didn't seem to work. Do we have some kind of permission disabled that stops iframing inside our docs? cc: @reimertz @il3ven

[estmcmxci]

The diagram looks great. I've started a hackmd with the embed attached; https://hackmd.io/@estmcmxci/neume-network-architecture

By the way, hackmd can connect to Github Repo, perhaps we can find some composability there for our workflow?

[il3ven]

@djfnd I checked and we can't embed iframe in GitHub's markdown. Ref: https://stackoverflow.com/a/54613247

[djfnd]

Okey doke, no stress!

[estmcmxci]

Copy that.

…

On Mon, Mar 27, 2023 at 4:32 AM Dan Fowler ***@***.***> wrote: OK wicked, I will have a little redesign of it in the next day or so then and present for feedback — Reply to this email directly, view it on GitHub <#5 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATKK5PJ25WNAXCGXXAOIDDLW6FGDJANCNFSM6AAAAAAWIZ5JJA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- *Marcus Martínez* *+1(201) 661-1607*