updated information that StructSense can be used from BrainKB website.#18
updated information that StructSense can be used from BrainKB website.#18tekrajchhetri merged 1 commit intomainfrom
Conversation
Summary of ChangesHello @tekrajchhetri, 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 enhances the user onboarding experience by providing an additional, more accessible method for interacting with StructSense. It introduces a direct link to the BrainKB website, allowing users to utilize StructSense's functionalities without the need for local installation, thereby streamlining the initial setup process for those who prefer a web-based approach. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request updates the getting started documentation to inform users that StructSense can be used directly from the BrainKB website. My review focuses on improving the readability of this new information. I've suggested a small change to make the link more user-friendly by using descriptive text instead of a raw URL, which also improves the sentence flow.
| cd structsense | ||
| pip install -e . | ||
| ``` | ||
| Or, if you prefer not to install anything, **use StructSense directly from the BrainKB website** at [https://beta.brainkb.org/](https://beta.brainkb.org/). |
There was a problem hiding this comment.
For better readability, consider using descriptive link text instead of the raw URL.1 Additionally, using the preposition 'on' would make the sentence sound more natural.
| Or, if you prefer not to install anything, **use StructSense directly from the BrainKB website** at [https://beta.brainkb.org/](https://beta.brainkb.org/). | |
| Or, if you prefer not to install anything, **use StructSense directly on the [BrainKB website](https://beta.brainkb.org/)**. |
Rules References
Footnotes
-
Using descriptive text for hyperlinks (e.g., 'BrainKB website') instead of the raw URL improves readability and accessibility. It provides users with clear context about the link's destination. ↩
this pull requests updates the information that StructSense can be used from BrainKB website.