-
Notifications
You must be signed in to change notification settings - Fork 2
Update README with service verification instructions #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Added note about verifying Query and ML Services.
Summary of ChangesHello @djarecka, 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 improves the project's documentation by adding essential verification instructions for the Query and ML Services. The update aims to prevent user confusion by guiding them to the correct Highlights
🧠 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 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.
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 updates the README.md to include instructions for verifying the Query and ML services. The addition is helpful for developers setting up the project locally. I've provided one suggestion to make the instructions even clearer by replacing the generic <port> placeholder with the specific default URLs for the service documentation pages, which enhances usability.
| - **Oxigraph SPARQL**: `http://localhost:7878/` (password protected) graph database | ||
| - **pgAdmin**: `http://localhost:5051/` | ||
|
|
||
| **Please note:** for the Query Service and ML Service, you won’t see anything at `http://localhost:<port>`. To verify that the services are running, open `http://localhost:<port>/docs` instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The note is helpful, but using <port> is a bit vague. Since the default ports are listed just above, it would be more user-friendly to provide the full, direct links to the documentation pages. This avoids ambiguity and makes verification easier for users following the quick start guide.
| **Please note:** for the Query Service and ML Service, you won’t see anything at `http://localhost:<port>`. To verify that the services are running, open `http://localhost:<port>/docs` instead. | |
| **Please note:** for the Query Service and ML Service, you won’t see anything at their base URLs. To verify they are running, open their API docs at `http://localhost:8010/docs` and `http://localhost:8007/docs` respectively. |
Added note about verifying Query and ML Services.