-
Notifications
You must be signed in to change notification settings - Fork 69
feat: Add Schema Descriptions for Academy UI #409
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
base: master
Are you sure you want to change the base?
feat: Add Schema Descriptions for Academy UI #409
Conversation
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
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.
Summary of Changes
Hello @zihanKuang, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces comprehensive schema descriptions for the Academy UI, primarily focusing on a new AcademyAdminSummary
object. These descriptions are intended to provide helpful context for users via "info" buttons within the Academy management console, enhancing clarity on various metrics and data points.
Highlights
- New
AcademyAdminSummary
Schema: A new schemaAcademyAdminSummary
has been defined, providing detailed descriptions for core statistics displayed on the academy management dashboard, including total learners, active learners, test statistics, and content details. - Enhanced Learner Status Definitions: Detailed descriptions have been added for aggregate learner statuses (registered, completed, withdrawn, failed) within the
learner_registration
object, clarifying their meaning in the context of group counts versus individual registration statuses. - OpenAPI Integration: The
AcademyAdminSummary
schema is now referenced as the response type for a relevant API endpoint, ensuring the UI consumes the newly documented structure. - Improved
CurriculaRegistrationsResponse
: A descriptive explanation has been added to theCurriculaRegistrationsResponse
schema, detailing its purpose for tracking content registrations.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: Aabid Sofi <[email protected]>
type: object | ||
test_stats: | ||
type: object | ||
description: "This panel provides a high-level summary of all test activities across your academy." |
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.
Don't describe the visual aspect. Describe the purpose and insight offered.
Co-authored-by: Lee Calcote <[email protected]> Signed-off-by: Zihan Kuang <[email protected]>
Co-authored-by: Lee Calcote <[email protected]> Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Notes for Reviewers
This PR introduces detailed descriptions for a new
AcademyAdminSummary
object. This content is designed to populate the "info" buttons within the Academy management console.Notes for Reviewers
The definition of learner statuses (
registered
,completed
, etc.) within the newlearner_registration
object.Although these statuses are already defined in the
AcademyRegistrationStatus
enum, they are defined again here. The reasoning is that theenum
defines the status for a single registration, while these new properties represent an aggregate count of a group of learners in each status.This PR is related to #405.