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

[SQL-261] Reactions tutorial rewrite #428

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

Conversation

kelvinqian00
Copy link
Collaborator

@kelvinqian00 kelvinqian00 commented Oct 4, 2024

The current Reactions tutorial mainly uses JSON examples, but JSON is mainly used as an internal storage format. This rewrite uses screenshots from the Reactions UI, which the user actually interfaces with, on the Reactions page. Meanwhile, a description of the internal reactions spec (based on the tables used by the xAPI statement and profile specs), along with the JSON example, have been moved to the developer documentation page.

@kelvinqian00 kelvinqian00 marked this pull request as ready for review October 23, 2024 15:21
@@ -117,4 +117,124 @@ java -cp bench.jar lrsql.bench [arguments]

Sample insert and query inputs can be found in the distribution at `bench/`

### Reaction JSON
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'm honestly not sure if this the dev documentation page is best place to put the reactions spec, since it makes it pretty long. Instead would it be a better idea to make a separate page for the spec?

Copy link
Collaborator Author

@kelvinqian00 kelvinqian00 Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These screenshots will be replaced with ones from the updated UI once that PR is merged.

@kelvinqian00 kelvinqian00 changed the title Reactions tutorial rewrite [SQL-261] Reactions tutorial rewrite Oct 23, 2024
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.

1 participant