Add a glossary to the documentation #759
Open
Conversation
This file contains hidden or 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
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
Author
|
/ok to test e7af4a9 |
TomAugspurger
added
doc
Contributor
Author
|
Preview: https://downloads.rapids.ai/ci/rapidsmpf/pull-request/759/e7af4a9/docs/rapidsmpf/html/glossary/ (nvidia VPN required) |
Co-authored-by: Mads R. B. Kristensen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've added a
glossarypage to the docs (at the top level with "Quickstart", "Background", "API Reference", and "Glossary"). The intent is to have a single place for defining all the concepts we have floating around.There's quite a bit of overlap with the API provided by rapidsmpf (classes like
BufferResource). I've tried to keep the glossary definitions very brief and very high level, leaving implementation details to the API reference.