-
Notifications
You must be signed in to change notification settings - Fork 301
docs: fix typo referenced in Flowise repo issue #5638 #201
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
Summary of ChangesHello @Yashxp1, 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 addresses a minor but important documentation update by correcting a typo in the 'Assistant' section of the main English README file. The change ensures the documentation is accurate and easy to read, directly resolving a reported issue to enhance user experience. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
Thank you for fixing the typo. Your change from "begineer-friendly" to "beginner-friendly" is correct. I noticed another small typo and a minor grammatical improvement on the same line, for which I've left a suggestion. With that small change, this pull request will be perfect.
en/README.md
Outdated
| ## Assistant | ||
|
|
||
| Assistant is the most begineer-friendly way of creating an AI Agent. Users can create chat assistant that is able to follow instructions, use tools when neccessary, and retrieve knowledge base from uploaded files ([RAG](https://en.wikipedia.org/wiki/Retrieval-augmented_generation)) to respond to user queries. | ||
| Assistant is the most beginner-friendly way of creating an AI Agent. Users can create chat assistant that is able to follow instructions, use tools when neccessary, and retrieve knowledge base from uploaded files ([RAG](https://en.wikipedia.org/wiki/Retrieval-augmented_generation)) to respond to user queries. |
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.
Thanks for catching that typo! I noticed another one on the same line: neccessary should be necessary. Also, adding the article "a" before "chat assistant" would improve the sentence's flow.
Here's a suggestion that incorporates both fixes.
| Assistant is the most beginner-friendly way of creating an AI Agent. Users can create chat assistant that is able to follow instructions, use tools when neccessary, and retrieve knowledge base from uploaded files ([RAG](https://en.wikipedia.org/wiki/Retrieval-augmented_generation)) to respond to user queries. | |
| Assistant is the most beginner-friendly way of creating an AI Agent. Users can create a chat assistant that is able to follow instructions, use tools when necessary, and retrieve knowledge base from uploaded files ([RAG](https://en.wikipedia.org/wiki/Retrieval-augmented_generation)) to respond to user queries. |
Fixed typos in the Assistant section on https://docs.flowiseai.com/
changed “begineer-friendly” to “beginner-friendly”.
changed "neccessary" to "necessary"
This issue was originally reported in the Flowise repository as issue #5638:
FlowiseAI/Flowise#5638