Skip to content

Conversation

zihanKuang
Copy link
Contributor

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 new learner_registration object.

Although these statuses are already defined in the AcademyRegistrationStatus enum, they are defined again here. The reasoning is that the enum 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.

image

Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Signed-off-by: ZihanKuang <[email protected]>
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 schema AcademyAdminSummary 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 the CurriculaRegistrationsResponse 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

  1. 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.

gemini-code-assist[bot]

This comment was marked as resolved.

Signed-off-by: ZihanKuang <[email protected]>
type: object
test_stats:
type: object
description: "This panel provides a high-level summary of all test activities across your academy."
Copy link
Member

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.

zihanKuang and others added 4 commits August 28, 2025 10:28
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