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

Modeling of types to represent query optimization with a persistent memo table #4

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

connortsui20
Copy link
Member

(draft)

DO NOT MERGE

yliang412 and others added 2 commits January 19, 2025 13:43
## 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

 - Check-in mdBook.
 - Add an initial overview that includes a wish list.
 - Add an initial glossary containing definitions and terms that optd developer will use.
 - Add a `rfcs/` directory with a template.
 - Add a pull request template (in `.github`).

## Future Work
- Set up gh-pages for the documentation. It might conflict with the benchmark site. We will delay deploying mdBook to gh-pages once a decision is made

---------

Signed-off-by: Yuchen Liang <[email protected]>
Co-authored-by: Connor Tsui <[email protected]>
This commit defines several key terms related to query optimization that we found were heavily overloaded last semester, leading to lots of confusion.

Since this document will evolve over time, there are still many TODOs that will have to be fixed later.

* update glossary and add lots of detail

* add directory

* clean style

* refactor and make section for each term

* Fill in all main sections with something

* clean up ending but leave TODOs
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.

2 participants