Adds code samples to fields and a set of documents around Entities #762
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.
Updates to the documentation that we use internally and may be useful to the community:
We added the following to "markdown_extensions" in "mkdocs.yml":
We use these to put code samples in "fields" in collapsible sections, so that code samples do not disrupt the flow of the document. We also use the "note" admonition throughout the entity documentation so that important notes (e.g. file references or system logic) are called out to the reader while working on Entities or fields in the backend.