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

Draw diagrams to improve docs #67

Open
2 tasks
DistributedDoge opened this issue Feb 23, 2024 · 1 comment
Open
2 tasks

Draw diagrams to improve docs #67

DistributedDoge opened this issue Feb 23, 2024 · 1 comment

Comments

@DistributedDoge
Copy link
Collaborator

DistributedDoge commented Feb 23, 2024

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

image

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
@DistributedDoge DistributedDoge changed the title Draw some diagrams to improve docs Draw diagrams to improve docs Feb 23, 2024
@davidgasquez
Copy link
Owner

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants