docs(readme): add draft MVP scope and modularity guidance

[Rit7439]

Description

Adds a small draft section to the README summarizing the currently discussed
MVP scope and guiding principles, based on community discussions. This is
intended to help align contributions without locking decisions early.

Type of Change

• Documentation update

[gemini-code-assist]

Summary of Changes

Hello @Rit7439, I'm Gemini Code Assist¹! 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 significant update to the project's README.md by adding a comprehensive draft section on the Minimum Viable Product (MVP) scope and guiding principles. This addition aims to provide a clear, evolving reference for contributors, ensuring alignment on core features and architectural decisions while promoting modularity and simplicity in development.

Highlights

• MVP Scope Documentation: A new section titled "Proposed MVP Scope (Draft)" has been added to the README.md to summarize the project's current MVP scope and guiding principles.
• Core MVP Features: The core 'must-have' features for the initial MVP are now explicitly listed, including secure image handling, privacy-first access control, and a simple architecture.
• Modular Extensions: Optional and modular extensions, such as admin dashboards and containerized deployment, are outlined to guide future development without blocking the core system.
• Guiding Principles: Key guiding principles for the project's development, emphasizing simplicity, avoiding early architectural locks, and modularity for advanced features, are now documented.

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

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

[gemini-code-assist]

Code Review

This pull request adds a valuable section to the README outlining the proposed MVP scope and guiding principles. The changes are well-structured and provide much-needed clarity for contributors. I have a couple of suggestions to further improve the clarity of the scope, particularly around the definition of admin roles in the MVP and the description of a research-oriented module, to make it more accessible to a broader range of contributors.

[gemini-code-assist]

There's a potential ambiguity between the core MVP feature "Privacy-first access control (user vs admin roles)" (line 31) and the optional extension "Admin dashboards and moderation tools" (line 38). It's unclear what admin capabilities are considered "core" versus "optional".

To improve clarity for contributors, I recommend refining these points to distinguish between backend capabilities (core) and frontend interfaces (optional).

For example, you could adjust the descriptions like this:

• Line 31: - Privacy-first access control (defining core user and admin roles/permissions)
• Line 38: - User-facing admin dashboards and moderation tools

This would make the MVP scope much clearer.