🧹📚 docs: refactor and clean up (#1392)

* 📑 update mkdocs

* rename docker override file and add to gitignore

* update .env.example - GOOGLE_MODELS

* update index.md

* doc refactor: split installation and configuration in two sub-folders

* doc update: installation guides

* doc update: configuration guides

* doc: new docker override guide

* doc: new beginner's guide for contributions - Thanks @Berry-13

* doc: update documentation_guidelines.md

* doc: update testing.md

* doc: update deployment guides

* doc: update /dev readme

* doc: update general_info

* doc: add 0 value to doc weight

* doc: add index.md to every doc folders

* doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md

* doc: update toc so they display properly on the right had side in mkdocs

* doc: update pandoranext.md

* doc: index logging_system.md

* doc: update readme.md

* doc: update litellm.md

* doc: update ./dev/readme.md

* doc:🔖 new presets.md

* doc: minor corrections

* doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs

* doc update: add screenshots to presets.md

* doc update: add screenshots to - OpenID with AWS Cognito

* doc update: BingAI cookie instruction

* doc update: discord auth

* doc update: facebook auth

* doc: corrections to user_auth_system.md

* doc update: github auth

* doc update: google auth

* doc update: auth clean up

* doc organization: installation

* doc organization: configuration

* doc organization: features+plugins & update:plugins screenshots

* doc organization: deploymend + general_info  & update: tech_stack.md

* doc organization: contributions

* doc: minor fixes

* doc: minor fixes
This commit is contained in:
Fuegovic 2023-12-22 08:36:42 -05:00 committed by GitHub
parent 5c27fa304a
commit 51050cc4d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
66 changed files with 1617 additions and 869 deletions

View file

@ -1,4 +1,8 @@
# ⚠️ **Breaking Changes** ⚠️
---
title: ⚠️ Breaking Changes
weight: -10
---
# ⚠️ Breaking Changes
> **Note:**
**If you experience any issues after updating, we recommend clearing your browser cache and cookies.**
@ -20,7 +24,7 @@ Certain changes in the updates may impact cookies, leading to unexpected behavio
## v0.5.8
- It's now required to name manifest JSON files (for [ChatGPT Plugins](..\features\plugins\chatgpt_plugins_openapi.md)) in the `api\app\clients\tools\.well-known` directory after their `name_for_model` property should you add one yourself.
- It's now required to name manifest JSON files (for [ChatGPT Plugins](../features/plugins/chatgpt_plugins_openapi.md)) in the `api\app\clients\tools\.well-known` directory after their `name_for_model` property should you add one yourself.
- This was a recommended convention before, but is now required.
## v0.5.7
@ -120,7 +124,7 @@ I had to change the environment variable from AZURE_OPENAI_API_KEY to AZURE_API_
---
### Docker
- The docker-compose file had some change. Review the [new docker instructions](../install/docker_compose_install.md) to make sure you are setup properly. This is still the simplest and most effective method.
- The docker-compose file had some change. Review the [new docker instructions](../install/installation/docker_compose_install.md) to make sure you are setup properly. This is still the simplest and most effective method.
---

View file

@ -0,0 +1,12 @@
---
title: General Information
weight: 4
---
# General Information
* ⚠️ [Breaking Changes](./breaking_changes.md)
* 👮 [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/.github/CODE_OF_CONDUCT.md)
* 🌍 [Multilingual Information](multilingual_information.md)
* 🧭 [Origin](project_origin.md)
* 🧑‍💻 [Tech Stack](tech_stack.md)

View file

@ -1,3 +1,7 @@
---
title: 🌍 Multilingual Information
weight: -9
---
# Multilingual Information
To set up the project, please follow the instructions in the documentation. The documentation is in English only, so you may need to use a translation tool or an AI assistant (e.g. ChatGPT) if you have difficulty understanding it.

View file

@ -1,3 +1,7 @@
---
title: 🧭 Origin
weight: -8
---
# Origin
This project was started early in Feb '23, anticipating the release of the official ChatGPT API from OpenAI, which is now used. It was originally created as a Minimum Viable Product (or MVP) for the [@HackReactor](https://github.com/hackreactor/) Bootcamp. It was built with OpenAI response streaming and most of the UI completed in under 20 hours. During the end of that time, I had most of the UI and basic functionality done. This was created without using any boilerplates or templates, including create-react-app and other toolchains. I didn't follow any 'un-official chatgpt' video tutorials, and simply referenced the official site for the UI. The purpose of the exercise was to learn setting up a full stack project from scratch.

View file

@ -1,9 +1,36 @@
---
title: 🧑‍💻 Tech Stack
weight: -8
---
# Tech Stack
## This project uses:
- [node-chatgpt-api](https://github.com/waylaidwanderer/node-chatgpt-api)
- No React boilerplate/toolchain/clone tutorials, created from scratch with react@latest
- Use of Tailwind CSS and [shadcn/ui](https://github.com/shadcn/ui) components
- Docker, useSWR, Redux, Express, MongoDB, [Keyv](https://www.npmjs.com/package/keyv)
- JavaScript/TypeScript: The project was initially developed entirely in JavaScript (JS). The frontend is in the process of transitioning from JS to TypeScript (TS). The backend is currently in JS, and there are considerations for transitioning it to TS in the future.
- React: The frontend UI is built using React.
- Express.js: The backend server is built using Express.js.
- OpenAI API: The project uses the official ChatGPT API from OpenAI.
- Docker: Docker is used for containerization of the application.
- MongoDB: MongoDB is used as the database for the application.
- npm: npm is used as the package manager.
- Git: Git is used for version control, following a GitFlow workflow.
- ESLint: ESLint is used for linting the codebase.
- Husky: Husky is used for pre-commit checks.
- Playwright: Playwright is used for running integration tests.
- GitHub: GitHub is used for hosting the codebase and managing contributions.
- Discord: Discord is used for community engagement and discussions.
- Various Cloud Deployment Options: The project supports deployment on multiple cloud platforms including DigitalOcean, Azure, Linode, Cloudflare, Ngrok, HuggingFace, and Render.