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

Transaction graph and docs cleanup #521

Merged
merged 2 commits into from
Nov 22, 2023

Conversation

JumiDeluxe
Copy link
Member

@JumiDeluxe JumiDeluxe commented Nov 21, 2023

Yesterday @piotro888 showed me transaction graph that is generated in docs with use of mermaid.
It was very small, but we noticed that it is readable (blocks, connections are still a mess but that is another issue) zooming in a lot.

I've scaled the graph and added scrolls to temporarily fix the graph problem, until someone fixes generation.
It looks quite good on mobile too and ctrl+F a phrase makes graph scroll to search result which is nice

Preview:

Mobile preview:

Also I've changed documentation files naming to kebab convention for consistency and better UX

(connected issue: #216)

@JumiDeluxe JumiDeluxe added the documentation Improvements or additions to documentation label Nov 21, 2023
@JumiDeluxe JumiDeluxe marked this pull request as draft November 21, 2023 18:18
@JumiDeluxe JumiDeluxe force-pushed the docs-graph-cleanup branch 2 times, most recently from 942855e to b8b0636 Compare November 21, 2023 18:22
@JumiDeluxe JumiDeluxe marked this pull request as ready for review November 21, 2023 18:26
Copy link
Member

@tilk tilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

docs/current-graph.md Outdated Show resolved Hide resolved
Copy link
Member

@Kristopher38 Kristopher38 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@tilk tilk merged commit 964065c into kuznia-rdzeni:master Nov 22, 2023
5 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants