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

Add validation feedback documentation #674

Merged
merged 3 commits into from
Jan 3, 2024

Conversation

fisher-alice
Copy link
Contributor

@fisher-alice fisher-alice commented Jan 2, 2024

This PR adds VALIDATION.md which contains documentation of validation feedback support for 2019 Dance Party and 2023 Dance Part AI Edition levels.

Screenshot 2024-01-02 at 3 23 28 PM

Screenshot 2024-01-02 at 3 46 38 PM

@fisher-alice fisher-alice requested a review from a team January 2, 2024 18:54
Copy link
Contributor

@sanchitmalhotra126 sanchitmalhotra126 left a comment

Choose a reason for hiding this comment

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

Great documentation! Thanks for adding this!

VALIDATION.md Outdated

For the 2023 version of Dance Party, additional support was added to `code-dot-org/dance-party` to provide more targeted feedback for users. Below are functions and variables that are used in level `validation_code` added for Dance Party: AI Edition.

| Name | Description |
Copy link
Contributor

@sanchitmalhotra126 sanchitmalhotra126 Jan 2, 2024

Choose a reason for hiding this comment

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

Just an idea - would it be helpful to include the version of dance party supported as a separate column and combine these two lists?

| Name | Description | Supported Versions |
| getCurrentPalette() | A function ... | Dance AI |
...
| pass() | A function ... | Dance AI, Dance 2019 |

edit: or have separate columns for each supported version, like | Name | Description | 2023 AI | 2019 |?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh yeah! I like the second option. Will update.

VALIDATION.md Outdated Show resolved Hide resolved
@fisher-alice fisher-alice requested a review from cnbrenci January 2, 2024 21:45
@fisher-alice fisher-alice merged commit 37689e9 into main Jan 3, 2024
1 check passed
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.

3 participants