mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-03-07 16:42:38 +01:00
🪪mkdocs: social cards (#1428)
* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder * docs: fix hyperlinks * mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides * mkdocs: social cards (descriptions) for all 'index.md' * mkdocs: social cards (descriptions) for 'features' and 'plugins' * mkdocs: social cards (descriptions) for 'general_info' * mkdocs: social cards (descriptions) for 'configuration' * mkdocs: social cards (descriptions) for 'installation' * mkdocs: minor fixes * update librechat.svg * update how_to_contribute.md add reference to the official GitHub documentation
This commit is contained in:
parent
18cd02d44e
commit
bce4f41fae
62 changed files with 393 additions and 329 deletions
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🧑💻 Code Standards and Conventions
|
||||
description: This guide covers the best practices for JavaScript coding, such as following the Airbnb Style Guide, using CommonJS modules, structuring the API using Express, Mongoose, and services, and testing and documenting the code using Jest, Supertest, Playwright, JSDoc, and TypeScript.
|
||||
weight: -7
|
||||
---
|
||||
# Coding Conventions
|
||||
|
|
@ -67,7 +68,7 @@ Defines Mongoose models to represent data entities and their relationships.
|
|||
|
||||
### 4. Database Access (MongoDB and Mongoose)
|
||||
|
||||
- Use Mongoose (https://mongoosejs.com) as the MongoDB ODM.
|
||||
- Use Mongoose ([https://mongoosejs.com](https://mongoosejs.com)) as the MongoDB ODM.
|
||||
- Create separate model files for each entity and ensure clear separation of concerns.
|
||||
- Use Mongoose schema validation to enforce data integrity.
|
||||
- Handle database connections efficiently and avoid connection leaks.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 📝 Documentation Guidelines
|
||||
description: Learn how to write and format documentation for LibreChat.
|
||||
weight: -9
|
||||
---
|
||||
# Documentation Guidelines
|
||||
|
|
@ -26,6 +27,7 @@ This document explains how to write and format documentation for LibreChat.
|
|||
```bash
|
||||
---
|
||||
title: Document Title
|
||||
description: This description will be used in social cards
|
||||
weight: 0
|
||||
---
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,8 +1,11 @@
|
|||
---
|
||||
title: 🙌 Beginner's Guide to Contributions
|
||||
description: Learn how to use GitHub Desktop, VS Code extensions, and Git rebase to contribute in a quick and easy way.
|
||||
weight: -10
|
||||
---
|
||||
# How to Contribute in a Quick and Easy Way
|
||||
> **❗Note:** If you are not familiar with the concept of repo, PR (pull request), fork and branch, start by looking at the official GitHub documentation on the subject:
|
||||
[https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)
|
||||
|
||||
## Installation of Tools
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Contributing to LibreChat
|
||||
description: "🙌 How to contribute to LibreChat: Get started, Documentation and code standards, Translate the app into different languages, Test the app during development, Ensure the security of the app, Stay updated with the project roadmap"
|
||||
weight: 5
|
||||
---
|
||||
# Contributing to LibreChat
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🧪 Testing During Development
|
||||
description: How to locally test the app during development.
|
||||
weight: -6
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🌍 Contribute a Translation
|
||||
description: How to add a new language to LibreChat.
|
||||
weight: -8
|
||||
---
|
||||
# How to add a new language to LibreChat 🌍
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue