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

Explain the concepts in glossary from a technical perspective #14

Closed
caro401 opened this issue Nov 17, 2023 · 3 comments
Closed

Explain the concepts in glossary from a technical perspective #14

caro401 opened this issue Nov 17, 2023 · 3 comments

Comments

@caro401
Copy link
Collaborator

caro401 commented Nov 17, 2023

This should eventually live somewhere separate, but for the moment, I'm mostly concerned with capturing the relevant information somewhere to help share the understanding within the team.

The current glossary file is concepts/glossary.md and contains some terminology which we all use. We should document what all these things are from a technical perspective, eg an operation is a python class which subclasses X and implements Y. Assume the target audience is very familiar with python, but not at all familiar with kiara. Short-ish definitions are good, especially for deeper concepts like the store and context - we can link out to much more detailed things when they exist (#12 etc)

see #8 for context, and for adding the higher level conceptual definitions.

@makkus
Copy link
Collaborator

makkus commented Nov 17, 2023

So should I add this directly to the glossary, or somewhere else? Use MB like Caitlinn did CB?

@caro401
Copy link
Collaborator Author

caro401 commented Nov 17, 2023

I have no opinion, just want the information to exist somewhere

@makkus makkus removed their assignment Nov 28, 2023
@caro401
Copy link
Collaborator Author

caro401 commented Dec 11, 2023

closed via #16

@caro401 caro401 closed this as completed Dec 11, 2023
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

No branches or pull requests

2 participants