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: add mermaid diagram support #677

Merged
merged 1 commit into from
Aug 4, 2022

Conversation

rkingsbury
Copy link
Collaborator

This PR adds support for mermaid diagrams to maggma and adds a small diagram to concepts.md in the docs that illustrates the relationship between Store and Builder. I envision mermaid diagrams being very useful for future docs updates as a way of illustrating the steps in a build pipeline.

This introduces no new dependencies; it simply requires a small configuration change in mkdocs.yml

@codecov
Copy link

codecov bot commented Jun 6, 2022

Codecov Report

Merging #677 (02df72f) into main (b506eb8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #677   +/-   ##
=======================================
  Coverage   89.43%   89.43%           
=======================================
  Files          42       42           
  Lines        3048     3048           
=======================================
  Hits         2726     2726           
  Misses        322      322           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84fba26...02df72f. Read the comment docs.

@rkingsbury
Copy link
Collaborator Author

@munrojm friendly reminder about this; what do you think? I'm about to introduce maggma to some colleagues and I think having a diagram in the docs that illustrates how Store and Builder work together would be really helpful to newcomers.

@munrojm
Copy link
Member

munrojm commented Aug 4, 2022

@rkingsbury, sorry I didn't circle back on this. I think this is a great addition. Did you want to add more figures in this PR or in a new one?

@rkingsbury
Copy link
Collaborator Author

Thanks @munrojm ! I think this is a good start as-is. Once support for mermaid in the docs is turned on we can easily add more as other parts of the docs evolve

@munrojm munrojm merged commit 1213685 into materialsproject:main Aug 4, 2022
@munrojm
Copy link
Member

munrojm commented Aug 4, 2022

Sounds good!

@rkingsbury rkingsbury deleted the mermaid branch October 25, 2022 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants