Design docs for "Construction of Enriched Research Knowledge Graphs and an Interactive User Interface for Project Grants and Research Findings"

[tekrajchhetri]

This PR contains the high-level design docs for "Construction of Enriched Research Knowledge Graphs and an Interactive User Interface for Project Grants and Research Findings"

This is clean version of #65.

[gemini-code-assist]

Summary of Changes

Hello @tekrajchhetri, 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 foundational design document that consolidates ideas, requirements, and early explorations for a new system. The system aims to construct enriched research knowledge graphs and provide an interactive user interface for exploring project grants and research findings. It sets clear goals, outlines detailed technical requirements for the knowledge graph, UI, and backend, and defines major task areas to guide future development, ensuring alignment with existing projects and a robust, scalable solution.

Highlights

• New Design Document Added: Introduced a comprehensive design document outlining the architecture, requirements, and tasks for the 'Construction of Enriched Research Knowledge Graphs and an Interactive User Interface for Project Grants and Research Findings'.
• Core Goals Defined: The document establishes three primary goals: constructing enriched research knowledge graphs, building an interactive user interface for exploration, and integrating with existing cross-project efforts like BICAN, BBQS, and Connects.
• Detailed Requirements: Specific requirements are laid out for the Knowledge Graph (RDF-based, defined ontology/schema, first-class provenance with W3C PROV-O), User Interface (intuitive search/navigation, user feedback, administrative ingestion), and Backend (service-oriented microservices, background jobs, import/export, scalability).
• Task Breakdown: The work is organized into major task areas: User Interface Design and Development, Ontology/Schema Modeling (including LinkML schemas), and Backend Services and Knowledge Graph Construction.

🧠 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/design_docs/PI-Grant-Skills-Research-Design.md
  • Added a new design document detailing the vision, use cases, goals, requirements, and task breakdown for the 'Construction of Enriched Research Knowledge Graphs and an Interactive User Interface for Project Grants and Research Findings' project.

Activity

• This pull request is a refined and clean version of a previous iteration, specifically referencing 'BrainKB/pull/65', indicating prior work and refinement on this design documentation.

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 introduces a high-level design document for the "Construction of Enriched Research Knowledge Graphs" project. The document is well-structured, covering use cases, goals, requirements, and tasks. My feedback focuses on improving the document's clarity and organization. I've provided a few suggestions to address a minor grammatical ambiguity and to enhance the formatting for better readability. Overall, this is a solid design document.

[tekrajchhetri]

@satra I have revised and updated my design documentation following Dandi Design Doc.

[satra]

this is still too general a design doc.

this doc should lay out details of what entities specifically should be represented (nothing with etc.,.), what attributes and properties of those entities should be considered, and what enrichment services would be implemented and what kind of enrichment should they provide.

and as noted in the comment, what is the value proposition or expected impact when you release this and how will you measure it?

[satra]

focus on what we can do that's different. most of this goal is addressed by dimensions.ai. it doesn't mean we don't have to implement many of these features, but those features won't add value. focus on the value proposition of the goal that is not being done by others.

[tekrajchhetri]

One of the interesting thing, at least for me, is the temporal aspect and being able to answer questions like "how has PIs evolved over time in terms of projects, skills...". I will make it very concrete on the updated design document.

[satra]

this is a longer time horizon, and one of the outcomes should be design docs that have at most a week or two week implementation/evaluation time.

[tekrajchhetri]

I will break it down to multiple design docs with detailed information along with timeline. Also, to clarify, this timeline was to complete all the task and it seems, we want the design document based on our sprint.