Draw diagrams to improve docs - Githubissues

davidgasquez / gitcoin-grants-data-portal

🌲 Open source, serverless, and local-first data hub for Gitcoin Grants data!

https://grantsdataportal.xyz/

MIT License

27 stars 3 forks source link

Draw diagrams to improve docs #67

Open DistributedDoge opened 7 months ago

DistributedDoge commented 7 months ago

I wanted to make high-level diagram showing how the project is set-up at the moment.

Open to suggestion if something could be tweaked.

Excalidraw: https://excalidraw.com/#json=2w27DpwY7oqSSwgdpyUT5,8zyALKj1K5pEKNAOvNPPuQ

I want to make another one focused on three kinds of data we have (Governance + Chain Data + Donations).

Two options where to put it, dealer's choice:

[ ] put it in README.md (maybe replace asset graph, which isn't very legible)
[ ] add some text and put it in architecture.md

davidgasquez commented 7 months ago

Love it! Let's start with this diagram and put it under the README.md. Can you share the Excalidraw URL?

You can click share and it'll create a Read Only link like this: https://excalidraw.com/#json=fkz4qhrIpLztalK07g_6g,mm-_-JbR85aGUlRq-zN4vA.

We can put the SVG there and link it to the shareable excalidraw URL for future editing!