Skip to content

docs: add KIVA modular feature implementation plan#86

Open
satra wants to merge 1 commit intomainfrom
codex/kiva-feature-plan
Open

docs: add KIVA modular feature implementation plan#86
satra wants to merge 1 commit intomainfrom
codex/kiva-feature-plan

Conversation

@satra
Copy link
Collaborator

@satra satra commented Mar 7, 2026

Summary

Testing

  • not run (documentation, issue planning, and project setup only)

References

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 a strategic blueprint for evolving the KIVA platform by modularizing its core features. The plan aims to establish a scalable and consistent architecture, ensuring that new capabilities are built as reusable components rather than isolated solutions. It addresses critical aspects of educational technology, from student interaction and performance to data insights and privacy, setting a foundation for future enhancements and broader application across different learning experiences.

Highlights

  • Modular Feature Plan: Added a comprehensive modular implementation plan for KIVA features, designed for reusability across various educational flows.
  • System Decomposition: The plan breaks down future development into six shared subsystems: reading-state grounding, pedagogical control, engagement detection, runtime latency, analytics, and privacy.
  • Project Management: Outlined the implementation work as specific GitHub issues (KIVA shared contracts and event schemas #77 through Privacy, data-use documentation, and instructional analytics surfacing #85) and organized them on Project 63, providing a clear roadmap for execution.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/kiva-modular-feature-plan.md
    • Added a new document detailing the KIVA modular feature implementation plan.
Activity
  • No activity has been recorded for this pull request yet.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

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.

Code Review

This pull request introduces a comprehensive and well-structured implementation plan for the KIVA modular feature. The document is detailed, breaking down the work into logical modules and phases. My review identified an issue with broken file links within the documentation, which should be corrected to ensure they are accessible to all team members. I have provided a suggestion to fix this.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment on lines +34 to +38
- KIVA uses advanced flows with `reading_context` and user state in [`src/server/activities/vocab-tutoring/flow_config.json`](/Users/satra/software/sensein/riverst/src/server/activities/vocab-tutoring/flow_config.json)
- indexable reading content already exists in activity resources and `get_reading_context` flow handling in [`src/server/bot/flows/handlers.py`](/Users/satra/software/sensein/riverst/src/server/bot/flows/handlers.py)
- audiobook playback already exposes word-level timing in [`src/client/react/src/pages/AudioPlayerPage.tsx`](/Users/satra/software/sensein/riverst/src/client/react/src/pages/AudioPlayerPage.tsx)
- session artifacts already include transcripts, audio, and metrics via [`src/server/bot/core/event_manager.py`](/Users/satra/software/sensein/riverst/src/server/bot/core/event_manager.py) and [`src/server/bot/monitoring/metrics_logger.py`](/Users/satra/software/sensein/riverst/src/server/bot/monitoring/metrics_logger.py)
- subtitle rendering is already present in the runtime UI in [`src/client/react/src/components/avatarInteraction/AvatarInteractionContent.tsx`](/Users/satra/software/sensein/riverst/src/client/react/src/components/avatarInteraction/AvatarInteractionContent.tsx)
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The file links in this section point to absolute local file paths (e.g., /Users/satra/...), which will be broken for other team members. To ensure they are accessible to everyone, please update them to use repository-relative paths. For example, a path like src/server/bot/flows/handlers.py should link to /src/server/bot/flows/handlers.py.

Suggested change
- KIVA uses advanced flows with `reading_context` and user state in [`src/server/activities/vocab-tutoring/flow_config.json`](/Users/satra/software/sensein/riverst/src/server/activities/vocab-tutoring/flow_config.json)
- indexable reading content already exists in activity resources and `get_reading_context` flow handling in [`src/server/bot/flows/handlers.py`](/Users/satra/software/sensein/riverst/src/server/bot/flows/handlers.py)
- audiobook playback already exposes word-level timing in [`src/client/react/src/pages/AudioPlayerPage.tsx`](/Users/satra/software/sensein/riverst/src/client/react/src/pages/AudioPlayerPage.tsx)
- session artifacts already include transcripts, audio, and metrics via [`src/server/bot/core/event_manager.py`](/Users/satra/software/sensein/riverst/src/server/bot/core/event_manager.py) and [`src/server/bot/monitoring/metrics_logger.py`](/Users/satra/software/sensein/riverst/src/server/bot/monitoring/metrics_logger.py)
- subtitle rendering is already present in the runtime UI in [`src/client/react/src/components/avatarInteraction/AvatarInteractionContent.tsx`](/Users/satra/software/sensein/riverst/src/client/react/src/components/avatarInteraction/AvatarInteractionContent.tsx)
- KIVA uses advanced flows with `reading_context` and user state in [`src/server/activities/vocab-tutoring/flow_config.json`](/src/server/activities/vocab-tutoring/flow_config.json)
- indexable reading content already exists in activity resources and `get_reading_context` flow handling in [`src/server/bot/flows/handlers.py`](/src/server/bot/flows/handlers.py)
- audiobook playback already exposes word-level timing in [`src/client/react/src/pages/AudioPlayerPage.tsx`](/src/client/react/src/pages/AudioPlayerPage.tsx)
- session artifacts already include transcripts, audio, and metrics via [`src/server/bot/core/event_manager.py`](/src/server/bot/core/event_manager.py) and [`src/server/bot/monitoring/metrics_logger.py`](/src/server/bot/monitoring/metrics_logger.py)
- subtitle rendering is already present in the runtime UI in [`src/client/react/src/components/avatarInteraction/AvatarInteractionContent.tsx`](/src/client/react/src/components/avatarInteraction/AvatarInteractionContent.tsx)

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