-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add glossary #56
base: main
Are you sure you want to change the base?
Add glossary #56
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Handful of things to update, should think about standardizing terms (e.g. Unix Domain Sockets, Abstract Syntax Tree)
An object containing new state used while evaluating a [policy](#policy). | ||
|
||
<a name="crypto-engine"></a>**Crypto Engine**\ | ||
Provides a set of APIs for encryption, decryption, and key authentication. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about key generation? @elagergren-spideroak looping you in since you'd know how to describe the crypto engine.
I like that the glossary links to different sections when those terms are used in the definition of another term. |
@@ -5,11 +5,152 @@ title: Glossary | |||
|
|||
# Glossary | |||
|
|||
## Section |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could maybe merge in the definitions from the overview page: https://aranya-project.github.io/aranya-docs/overview/#glossary and then remove that section from overview.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that would be good, some of these are more specific and work better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re-request me when the above gets addressed, wanna look those changes over.
This PR adds the glossary from our internal wiki to the docs site.
Closes #40