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

Add glossary #56

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add glossary #56

wants to merge 3 commits into from

Conversation

smckeon-so
Copy link
Collaborator

@smckeon-so smckeon-so commented Feb 11, 2025

This PR adds the glossary from our internal wiki to the docs site.

Closes #40

Copy link
Contributor

@nikki-aranya nikki-aranya left a 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)

nikki-aranya
nikki-aranya previously approved these changes Feb 12, 2025
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.
Copy link
Contributor

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.

@gknopf-aranya
Copy link
Contributor

I like that the glossary links to different sections when those terms are used in the definition of another term.
If there is a documentation page on the website for a particular term, e.g. the braid, afc, ephemeral sessions, etc. let's make sure to link to that documentation page from the glossary as well.

pages/_glossary/glossary.md Show resolved Hide resolved
pages/_glossary/glossary.md Show resolved Hide resolved
pages/_glossary/glossary.md Show resolved Hide resolved
pages/_glossary/glossary.md Show resolved Hide resolved
@@ -5,11 +5,152 @@ title: Glossary

# Glossary

## Section
Copy link
Contributor

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.

Copy link
Collaborator Author

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.

Copy link
Contributor

@nikki-aranya nikki-aranya left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Glossary page for the doc site
7 participants