Docs: add Document Models / emmet tutorial #917
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This looks fantastic, thanks @rkingsbury |
|
Thanks @utf . I just realized that I didn't add a link to this tutorial from the navigation menu, so it's only visible if you search for it. I'll try to correct soon but wanted to make you aware in case you're working on other documentation updates. The link is https://materialsproject.github.io/atomate2/user/docs_schemas_emmet.html |
BryantLi-BLI
pushed a commit
to BryantLi-BLI/atomate2
that referenced
this pull request
Jul 29, 2024
* Docs: add schema tutorial * lnt
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds the tutorial "An introduction to task documents, schemas, and emmet" as requested in #750 . Thanks to @abhardwaj73 for contributing the
TaskDocoutput which is included.I've tried to be comprehensive about the key points of a "typical" task doc structure, but I'm sure there are some things I've misstated, so @utf and others please feel free to request edits/changes.
In case it's difficult to preview the built documentation with my changes, I am attaching a .pdf of my locally built version.
An introduction to task documents, schemas, and emmet - atomate2.pdf