-
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
docs: add mdBook based documentation #2
Conversation
Signed-off-by: Yuchen Liang <yuchenl3@andrew.cmu.edu>
6a158cd
to
61b2ac7
Compare
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.
Nit: Instead of pointing out every place, is it possible to remove all trailing whitespace and make sure there are newlines at the end of files?
This isn't really that important, it's just that I have my IDE set up to scream at me every time one of those things happens 😄
Signed-off-by: Yuchen Liang <yuchenl3@andrew.cmu.edu>
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.
On thinking about this a bit more after @SarveshOO7 pointed this out, I think it would be good to distinguish between nodes and operators, especially considering we need to represent relations connected by pointers (in-memory) as well as connected via identifiers (on disk in the memo table).
Node: an in-memory node in a tree / DAG representing a relation / scalar
Operator: A representation of a relation / scalar that is not necessarily in memory
EDIT: OR
We could say everything that needs to be stored in the memo table is an expression (logical, physical, scalar expression), and then we say operators and nodes are purely in-memory (the initial input logical plan and final output physical plan are trees of operators / nodes)
I'm now in favor of the latter...
Could we maybe separate our the glossary from this PR?
We can change the definitions. The main goal for this PR is to structure the docs directory. |
Problem
We need to record our design and retain knowledge of the codebase as a team. Documentation is one of the best ways to do it.
Summary of changes
rfcs/
directory with a template..github
).Future Work