makkus
commented
7 months ago A good piece of follow-up would be for Markus or me to add a little more docs about what these things are on a technical level (like, an operation inherits from X python class) to aid developers (ok, me!) in grounding these concepts in the code.
Can do, but I'd recommend to put that level of detail into a different (low level) section of the docs. I'd put the line at the API level, that should expose (and explain) everything that would be used by a client developer or end user (we can have 2 sections there, since the requirements are slightly (actually, more than just slightly probably) different, but not sure). If there is something that can't be done via the api, then an endpoint should be added because it hints at some abstraction not being exposed properly, rather than requiring the client dev having to understand those sorts of internal details. A grey area being the objects that are returned by the API, there I would consider simple attribute getters being part of the API, but anything more complicated should either become a simple attribute on one of those return objects, or get its own API endpoint.
caro401
Thanks for writing this up! It's a really great explanation of how to understand a bunch of concepts in Kiara as an end-user. As long as @makkus is happy there's nothing technically incorrect or misleading, let's merge this.
A good piece of follow-up would be for Markus or me to add a little more docs about what these things are on a technical level (like, an operation inherits from X python class) to aid developers (ok, me!) in grounding these concepts in the code.