GITBOOK-136: Ambika's Jul 22 changes

SUMMARY.md

@@ -36,6 +36,11 @@
 * [📊 How to create language evaluation for ASR?](guides/how-to-create-language-evaluation-for-asr.md)
 * [How does RAG-based document search work?](guides/how-does-rag-based-document-search-work.md)
 
+## 😇 CONTRIBUTING
+
+* [Contributing](contributing/contributing.md)
+* [Documentation Style Guide](contributing/documentation-style-guide.md)
+
 ## 🤓 API REFERENCE
 
 * [Getting started](api-reference/getting-started.md)

contributing/contributing.md

@@ -0,0 +1,50 @@
+# Contributing
+
+## **Welcome Contributors** <a href="#inhnbn3q0ba8" id="inhnbn3q0ba8"></a>
+
+Hello there! Thank you for your interest in contributing to Gooey.AI. &#x20;
+
+### **🗺️ Guidelines** <a href="#ijrkkii9v589" id="ijrkkii9v589"></a>
+
+#### **👩‍💻 Ways to contribute** <a href="#srvcn5b1nf7z" id="srvcn5b1nf7z"></a>
+
+There are many ways to contribute to Gooey.AI. Here are some ways you can contribute:
+
+* [**Documentation**](documentation-style-guide.md): Help improve our docs, including this one!
+* [**Code**](https://github.com/GooeyAI/gooey-server): Help us write code, fix bugs, or improve our infrastructure.
+* **Integrations**: Help us integrate with your favorite communication platform, vendors and tools.
+* [**Discussions**](https://github.com/GooeyAI/gooey-server/discussions): Help answer usage questions and discuss issues with users.
+* **Shared AI Recipes**: Create amazing AI workflows on Gooey and save them publicly on your profile page so others can fork them.
+
+#### **🚩 GitHub Issues** <a href="#wq90yd4qlpci" id="wq90yd4qlpci"></a>
+
+Our [issues](https://github.com/GooeyAI/gooey-server/issues) page is kept up to date with bugs, improvements, and feature requests.
+
+There is a taxonomy of labels to help with sorting and discovery of issues of interest. Please use these to help organize issues.
+
+If you start working on an issue, please assign it to yourself.
+
+If you are adding an issue, please try to keep it focused on a single, modular bug/improvement/feature. If two issues are related, or blocking, please link them rather than combining them.
+
+We will try to keep these issues as up-to-date as possible, though with the rapid rate of development in this field some may get out of date. If you notice this happening, please let us know.
+
+**🐛 Fix Bugs**
+
+Most bugs are reported and tracked in the Github Issues Page. We try our best in triaging and tagging these issues:
+
+* Issues tagged as `bug` are confirmed bugs.
+* New contributors may want to start with issues tagged with `good first issue`.
+
+Please feel free to open an issue and/or assign an issue to yourself.
+
+#### **💭 GitHub Discussions** <a href="#mdugft7kjty8" id="mdugft7kjty8"></a>
+
+We have a [Github Discussions](https://github.com/GooeyAI/gooey-server/discussions) page where users can ask usage questions, discuss design decisions, and propose new features.
+
+If you can help answer questions, please do so! This will allow the maintainers to spend more time focused on development and bug fixing.
+
+#### **🙋 Getting Help** <a href="#nx18z0xou2uf" id="nx18z0xou2uf"></a>
+
+Our goal is to have the simplest developer setup possible. Should you experience any difficulty getting set up, please reach out on Discord ([https://gooey.ai/discord](https://gooey.ai/discord)) or contact a team member at [email protected]!! Not only do we want to help get you unblocked, but we also want to make sure that the process is smooth for future contributors.
+
+We do enforce certain linting, formatting, and documentation standards in the codebase. If you find these difficult (or even just annoying) to work with, feel free to contact a maintainer for help - we do not want these to get in the way of getting good code into the codebase.

contributing/documentation-style-guide.md

@@ -0,0 +1,35 @@
+# Documentation Style Guide
+
+## **Documentation Style Guide** <a href="#id-2gidycpw9q4p" id="id-2gidycpw9q4p"></a>
+
+To maintain industry parity, we take inspiration from the best, our Documentation Style Guide is based on [Langchain's Documentation Style Guide](https://python.langchain.com/v0.2/docs/contributing/documentation/style\_guide/#general-guidelines)
+
+### **General guidelines**[**​**](https://python.langchain.com/v0.2/docs/contributing/documentation/style\_guide/#general-guidelines) <a href="#u06mnxhr6vqy" id="u06mnxhr6vqy"></a>
+
+Here are guidelines for contributing and writing docs for Gooey.AI.
+
+#### **Avoid duplication**[**​**](https://python.langchain.com/v0.2/docs/contributing/documentation/style\_guide/#avoid-duplication) <a href="#id-2bamt5jlsl9z" id="id-2bamt5jlsl9z"></a>
+
+Multiple pages that cover the same material in depth are difficult to maintain and cause confusion. There should be only one (very rarely two), canonical pages for a given concept or feature. Instead, you should link to other guides.
+
+#### **Link to other sections**[**​**](https://python.langchain.com/v0.2/docs/contributing/documentation/style\_guide/#link-to-other-sections) <a href="#id-227g7xprhisq" id="id-227g7xprhisq"></a>
+
+Because sections of the docs do not exist in a vacuum, it is important to link to other sections as often as possible to allow a developer to learn more about an unfamiliar topic inline.
+
+**This includes linking to the API references as well as conceptual sections!**
+
+#### **Be concise**[**​**](https://python.langchain.com/v0.2/docs/contributing/documentation/style\_guide/#be-concise) <a href="#id-7trs8xwq50e2" id="id-7trs8xwq50e2"></a>
+
+In general, take a less-is-more approach. If a section with a good explanation of a concept already exists, you should link to it rather than re-explain it, unless the concept you are documenting presents some new wrinkle.
+
+Be concise, including in code samples.
+
+#### **General style**[**​**](https://python.langchain.com/v0.2/docs/contributing/documentation/style\_guide/#general-style) <a href="#lvse80j7jo34" id="lvse80j7jo34"></a>
+
+* Use active voice and present tense whenever possible
+* Use examples and code snippets to illustrate concepts and usage
+* Use appropriate header levels (#, ##, ###, etc.) to organize the content hierarchically
+* Use fewer cells with more code to make copy/paste easier
+* Use bullet points and numbered lists to break down information into easily digestible chunks
+* Use tables (especially for Reference sections) and diagrams often to present information visually
+* Include the table of contents for longer documentation pages to help readers navigate the content, but hide it for shorter pages

guides/copilot/README.md

@@ -34,21 +34,21 @@ Our approach with Gooey.AI is that we learn best when we can see work of others
 
 [Gooey.AI's Copilot](https://gooey.ai/copilot) is the most advanced chatbot maker in the industry. It offers:
 
-* Selection of multiple [Large Language Models](https://gooey.ai/llm) (OpenAI GPT3.5, GPT4, GPT4-Turbo, GPT4-Vision, Meta's LLaMa2, Google PaLM2 and Gemini)
+* Selection of multiple [Large Language Models](https://gooey.ai/llm) (OpenAI GPT4o, GPT4o-mini, GPT4-Turbo, GPT4-Vision, Meta's LLaMa2, Google PaLM2 and Gemini 1.5 Pro and Claude 3.5)
 * Document OCR and Vision (examples: [simple](https://gooey.ai/copilot/?example\_id=v1xm6uhp), [BibleBot](https://gooey.ai/copilot/?example\_id=iiyv5ch7) and another that [fills out a form from photos](https://gooey.ai/copilot/?example\_id=n13jrsob))
-* Integrations with Facebook, Slack, Whatsapp, Instagram and Websites (via landbot). Or publish your bot as API to integration into your own app.
+* Integrations with Facebook, Slack, [Whatsapp](deploy-on-whatsapp.md), Instagram and Websites (via [custom one-click web widget](deploy-to-web.md)). Or publish your bot as API to integration into your own app.
 * [Synthetic Data Extraction](prepare-synthetic-data.md) (e.g. to turn video transcripts into FAQs)
-  * This allows you to transform both PDFs and videos into editable google sheets, with all the text/transcript extracted and optionally translated. Additionally, it allows you to build an automatic FAQ for each page, with citations given to the particular page number. We’ve found this dramatically improves search results.
+  * This allows you to transform both PDFs and videos into editable Google sheets, with all the text/transcript extracted and optionally translated. Additionally, it allows you to build an automatic FAQ for each page, with citations given to the particular page number. We’ve found this dramatically improves search results.
 * Built-in feedback buttons and [configurable conversation analysis](conversation-analysis.md)
-* Retrieval Augmented Generation (with a Google doc, PDF, or Excel.) + advanced features  including:
+* [Retrieval Augmented Generation](./#what-is-retrieval-augmented-generation) (with a Google doc, PDF, or Excel and even Weblinks) + advanced features  including:
   * Dense Embeddings 
   * Keyword Search Extraction - useful for highly technical knowledge bases with lots of jargon 
   * Conversation summarization - to create better vector DB queries
-* [Speech Recognition & Translation](https://gooey.ai/speech) to understand incoming audio messages, powered by the latest models from Azure, Google, Meta, OpenAI and Bhashini.
-* Language translations (including Google Translate, Bhashini, Seamless)
-* Text-to-Speech from Google, Uberduck, and EvelenLabs (so the bot can send back audio responses)
+* [Speech Recognition & Translation](https://gooey.ai/speech) to understand incoming audio messages, powered by the latest models from Azure, Google, Meta, OpenAI, and Bhashini.
+* [Language translations (including Google Translate, Bhashini, Seamless)](https://app.gitbook.com/s/leYcqBx5FRZcVr3wI4f4/global-language-understanding-for-ais)
+* Text-to-speech from Google, Uberduck, and EvelenLabs (so the bot can send back audio responses)
 * Video generation with[ LipSync with Text-to-Speech.](https://gooey.ai/lipsynctts) 
-* Bulk Evaluation. With this you specify a set of test questions and golden answers and then the tool automatically compares and score competing versions of your bot.
+* Bulk Evaluation: with this, you specify a set of test questions and golden answers, and then the tool automatically compares and scores competing versions of your bot.
 
 ## How it works?
 
@@ -62,13 +62,13 @@ Your data is prepared and indexed and when the user queries the AI Copilot searc
 
 1. Remains accurate and up-to-date 
 2. It avoids hallucinating for a response
-3. Do not respond to queries beyond the scope of your knowledge (unless you want it to).  
+3. It does not respond to queries beyond the scope of your **Knowledge Base** (unless you want it to).  
 4. Mitigates risk to the organization
 5. Builds users' trust by providing relevant information
 
 #### How does RAG LLM work?
 
-<img src="../../.gitbook/assets/file.excalidraw.svg" alt="" class="gitbook-drawing">
+<figure><img src="../../.gitbook/assets/How does RAG-based document search work_.jpg" alt=""><figcaption></figcaption></figure>
 
 ### REAL-WORLD OVERVIEW OF COPILOT VIA FARMER.CHAT