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

docs: Update for blockchain v5 module. #3149

Merged
merged 1 commit into from
Jun 27, 2023

Conversation

davecgh
Copy link
Member

@davecgh davecgh commented Jun 18, 2023

This updates the module hierarchy graphviz and module hierarchy diagram to accurately reflect the latest blockchain module dependencies.

In particular, blockchain/v5 no longer relies on the gcs, stake, or database modules.

It also rearranges the definitions a bit in the graphviz to produce a more balanced diagram.

@davecgh davecgh added the documentation Issues and/or pull requests related to documentation. label Jun 18, 2023
@davecgh davecgh added this to the 1.9.0 milestone Jun 18, 2023
@davecgh davecgh force-pushed the docs_module_hierarchy_update branch from 28846e0 to 7348d64 Compare June 19, 2023 19:26
@JoeGruffins
Copy link
Member

Setting a margin on the nodes in the .gv can make them a bit more readable. The text does not bleed over the lines.

digraph {
	graph [splines=ortho colorscheme=svg label=<<u>Module Hierarchy</u>> labelloc=t fontsize=18.0]
	node [shape=box style="filled, rounded" margin=0.01]

image

@davecgh
Copy link
Member Author

davecgh commented Jun 26, 2023

Setting a margin on the nodes in the .gv can make them a bit more readable. The text does not bleed over the lines.

Are you looking at the SVG being committed or generating using local tooling?

I ask because I don't see any text bleedover and I'm wondering if you're using a different layout engine. In fact, the default margin value used by DOT (the layout engine I'm using) is more than 0.01 and as a result, using 0.01 actually makes the generated SVG (with DOT) worse.

A value of 0.1 looks good here. Does that work for you?

@JoeGruffins
Copy link
Member

JoeGruffins commented Jun 26, 2023

Are you looking at the SVG being committed or generating using local tooling?

Both. Here is what I see on firefox:
image

opening with gimp:
image

and it looks a lot better here, and sorry for the resolution, but on chrome on mobile:
image

A value of 0.1 looks good here. Does that work for you?

Yes that also looks fine using dot -Tsvg module_hierarchy.gv > test.svg and viewing with gimp.

This updates the module hierarchy graphviz and module hierarchy diagram
to accurately reflect the latest blockchain module dependencies.

In particular, blockchain/v5 no longer relies on the gcs, stake, or
database modules.

It also rearranges the definitions a bit in the graphviz to produce a
more balanced diagram.
@davecgh
Copy link
Member Author

davecgh commented Jun 26, 2023

That's odd. How is what I see for the original SVG I linked on FF:

image

It looks the same on chrome too.

Anyway, I updated it to include a margin of 0.1 since that seems to look good for you and still looks good for me on FF, Chrome Desktop, and Chrome mobile.

@davecgh davecgh force-pushed the docs_module_hierarchy_update branch from 7348d64 to cc33b71 Compare June 26, 2023 22:33
@davecgh davecgh merged commit cc33b71 into decred:master Jun 27, 2023
2 checks passed
@davecgh davecgh deleted the docs_module_hierarchy_update branch June 27, 2023 00:53
@JoeGruffins
Copy link
Member

It's really not worth wasting time over, but it looks the same for me even after the margins are changed. I don't know why. It appears setting the margin isn't the problem, it's something to do with our different dot builds I guess. And different vector graphics viewing interpretations? I wonder if it looks fine for others and is just me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and/or pull requests related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants