🔍 chore: Clean Up Documentation (#2217)

* fix(initializeClient.spec.js): remove condition failing test on local installations

* docs: remove comments and invalid html as is required by embeddings generator and add new documentation guidelines
This commit is contained in:
Danny Avila 2024-03-26 13:40:00 -04:00 committed by GitHub
parent 2259bf8b03
commit 7f83a060a0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 17 additions and 131 deletions

View file

@ -4,7 +4,7 @@ description: How to install and configure Mongo Express to securely access and m
weight: -5
---
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/4572dd35-8489-4cb1-a968-4fb5a871d6e5" height="50">
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/4572dd35-8489-4cb1-a968-4fb5a871d6e5" height="50"/>
# Manage Your MongoDB Database with Mongo Express

View file

@ -11,21 +11,6 @@ To learn more about them, or how to make your own, read here: **[ChatGPT Plugins
Thanks to the introduction of **[OpenAI Functions](https://openai.com/blog/function-calling-and-other-api-updates)** and their utilization in **[Langchain](https://js.langchain.com/docs/modules/chains/openai_functions/openapi)**, it's now possible to directly use OpenAI Plugins through LibreChat, without building any custom langchain tools. The main use case we gain from integrating them to LibreChat is to allow use of plugins with gpt-3.5 models, and without ChatGPT Plus. They also find a great use case when you want to limit your own private API's interactions with chat.openai.com and their servers in favor of a self-hosted LibreChat instance.
<!-- ### Table of Contents
- [Using official ChatGPT Plugins / OpenAPI specs](#using-official-chatgpt-plugins--openapi-specs)
- [Table of Contents](#table-of-contents)
- [Intro](#intro)
- [**Plugin Manifest File:**](#plugin-manifest-file)
- [**OpenAPI Spec**](#openapi-spec)
- [Adding a Plugin](#adding-a-plugin)
- [Editing Manifest Files](#editing-manifest-files)
- [Override Parameter Values](#override-parameter-values)
- [Add Header Fields](#add-header-fields)
- [Custom OpenAPI Spec files](#custom-openapi-spec-files)
- [Plugins with Authentication](#plugins-with-authentication)
- [Showcase](#showcase)
- [Disclaimers](#disclaimers) -->
## Intro
Before continuing, it's important to fully distinguish what a Manifest file is vs. an OpenAPI specification.

View file

@ -13,10 +13,7 @@ GOOGLE_CSE_ID="...."
You first need to create a programmable search engine and get the search engine ID: **[https://developers.google.com/custom-search/docs/tutorial/creatingcse](https://developers.google.com/custom-search/docs/tutorial/creatingcse)**
Then you can get the API key, click the "Get a key" button on this page: **[https://developers.google.com/custom-search/v1/introduction](https://developers.google.com/custom-search/v1/introduction)**
<!-- You can limit the max price that is charged for a single search request by setting `MAX_SEARCH_PRICE` in your `.env` file. -->
Then you can get the API key, click the "Get a key" button on this page: **[https://developers.google.com/custom-search/v1/introduction](https://developers.google.com/custom-search/v1/introduction)**
## 1\. Go to the [Programmable Search Engine docs](https://developers.google.com/custom-search/docs/tutorial/creatingcse) to get a Search engine ID

View file

@ -77,7 +77,7 @@ To export a preset, first go in the preset menu, then click on the button to edi
Then in the bottom of the preset settings you'll have the option to export it.
<p align="left">
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/a624345f-e3e6-4192-8384-293ba6ce54cc" width="50%">
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/a624345f-e3e6-4192-8384-293ba6ce54cc" width="50%"/>
</p>
## Setting Default Preset

View file

@ -16,7 +16,7 @@ weight: -2
The LibreChat-DiscordBot is a versatile and user-friendly Discord bot designed to streamline interactions with your LibreChat server. With this bot, you can effortlessly manage the LibreChat server directly from your Discord server, eliminating the need for direct server access. It offers an array of functionalities to enhance your LibreChat experience.
<div>
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/d3841040-64d0-402f-95a5-8eb07bfbbfe5" width=400>
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/d3841040-64d0-402f-95a5-8eb07bfbbfe5" width=400 />
</div>
---
@ -26,8 +26,8 @@ The LibreChat-DiscordBot is a versatile and user-friendly Discord bot designed t
This app is a webview for LibreChat instance Android independent app, this project is forked from ChatGPT-android-app. Default webpage of this app has been set to LibreChat's GitHub Page. This app is optimized for LibreChat's function which is not an original project. For example, Social Login Oauth login support is added to this build.
<div>
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/2da13b4c-8d77-42fc-9d36-75e9913d0545" width=300>
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/6ec84228-f030-4aa9-9f9d-d81245dd9c03" width=300>
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/2da13b4c-8d77-42fc-9d36-75e9913d0545" width=300 />
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/6ec84228-f030-4aa9-9f9d-d81245dd9c03" width=300 />
</div>
---
@ -45,7 +45,7 @@ This script automates the local Windows 64 bits installation and offers a utilit
A Terraform setup to deploy LibreChat to Azure and setup all the necessary services.
<div>
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Microsoft_Azure.svg/1280px-Microsoft_Azure.svg.png" width=150>
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Microsoft_Azure.svg/1280px-Microsoft_Azure.svg.png" width=150 />
</div>
---