You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-90
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@
26
26
</a>
27
27
</p>
28
28
29
-
# Features
29
+
# 📃 Features
30
30
- 🖥️ UI matching ChatGPT, including Dark mode, Streaming, and 11-2023 updates
31
31
- 💬 Multimodal Chat:
32
32
- Upload and analyze images with GPT-4 and Gemini Vision 📸
@@ -46,7 +46,7 @@
46
46
[For a thorough review of our features, see our docs here](https://docs.librechat.ai/features/plugins/introduction.html) 📚
47
47
48
48
49
-
## All-In-One AI Conversations with LibreChat
49
+
## 🪶 All-In-One AI Conversations with LibreChat
50
50
LibreChat brings together the future of assistant AIs with the revolutionary technology of OpenAI's ChatGPT. Celebrating the original styling, LibreChat gives you the ability to integrate multiple AI models. It also integrates and enhances original client features such as conversation and message search, prompt templates and plugins.
51
51
52
52
With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use free or pay-per-call APIs. We welcome contributions, cloning, and forking to enhance the capabilities of this advanced chatbot platform.
@@ -58,113 +58,35 @@ Click on the thumbnail to open the video☝️
**Please read this before updating from a previous version**
61
+
## 📚 Documentation
62
+
For more information on how to use our advanced features, install and configure our software, and access our guidelines and tutorials, please check out our documentation at [docs.librechat.ai](https://docs.librechat.ai)
64
63
65
64
---
66
65
67
-
## Changelog
66
+
## 📝 Changelog
68
67
Keep up with the latest updates by visiting the releases page - [Releases](https://github.com/danny-avila/LibreChat/releases)
<imgalt="Star History Chart"src="https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date&theme=dark"onerror="this.src='https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date'" />
155
78
</a>
156
79
157
80
---
158
81
159
-
## Contributors
160
-
Contributions and suggestions bug reports and fixes are welcome!
161
-
Please read the documentation before you do!
82
+
## ✨ Contributions
83
+
Contributions, suggestions, bug reports and fixes are welcome!
162
84
163
85
For new features, components, or extensions, please open an issue and discuss before sending a PR.
164
86
165
-
- Join the [Discord community](https://discord.gg/uDyZ5Tzhct)
87
+
---
166
88
167
-
This project exists in its current state thanks to all the people who contribute
89
+
💖 This project exists in its current state thanks to all the people who contribute
Copy file name to clipboardexpand all lines: docs/contributions/documentation_guidelines.md
+20-8
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,40 @@
1
+
---
2
+
title: 📝 Documentation Guidelines
3
+
weight: -9
4
+
---
1
5
# Documentation Guidelines
2
6
3
7
This document explains how to write and format documentation for LibreChat.
4
8
5
9
## New Documents
6
10
- Use lowercase letters and underscores to name new documents (e.g. `documentation_guidelines.md`).
7
-
- For new features, create new documentation and place it in the relevant folder/sub-folder under [docs](../docs/).
8
-
- If the feature adds new functionality, add it to the feature section of the main [README.md](../../README.md).
9
-
- When you create a new document, **add it to both table of contents:**
10
-
-[README.md](../../README.md)
11
-
-[mkdocs.yml](../../mkdocs.yml)
11
+
- For new features, create new documentation and place it in the relevant folder/sub-folder under `../docs`.
12
+
- If the feature adds new functionality, add it to the feature section of the main `README.md` as well as in `../docs/index.md`.
13
+
- When you create a new document, **you need to add it to two table of contents:**
14
+
-in `README.md`
15
+
-and in the `index.md` file in the folder where your doc is located
12
16
13
-
## Formatting
17
+
## Markdown Formatting
14
18
- Use `#`, `##`, and `###` for headings and subheadings.
15
19
- Use `#` for the title of the document.
16
20
- Use `##` for the main sections of the document.
17
21
- Use `###` for the sub-sections within a section.
18
-
- Use `**` to make text bold to highlight important information (not in place of a heading).
22
+
- Use `**` to make text **bold** to highlight important information (do not use in place of a heading).
19
23
- Use relative paths for links to other documents.
20
24
- You can use HTML to add more features to a document.
25
+
- By default the title indexed by mkdocs will be the first heading. You can override this by adding metadata at the top of your document:
26
+
```bash
27
+
---
28
+
title: Document Title
29
+
weight: 0
30
+
---
31
+
```
32
+
- Setting the weight in the document metadata will influence its position in the table of contents. Lowest weight are placed first. Not setting it will default to `0`. When multiple docs have the same weight it sorts in alphabetical order.
21
33
22
34
## Important Notes
23
35
-**⚠️Keep it organized and structured⚠️**
24
36
- Do not add unrelated information to an existing document. Create a new one if needed.
25
-
- All assets should be uploaded in the document from GitHub's webui:
37
+
- All assets should be uploaded in the document from GitHub's webui
26
38
-**Before submitting a PR, double-check on GitHub that everything is properly displayed and that all links work correctly.**
5. Start modifying the code, and when you finish a part, commit the changes.
34
+
Example of commits:
35
+
- commit1: Created the frontend
36
+
- commit2: Fixed a bug in variable export
37
+
- commit3: Removed unnecessary comments and added translation support
38
+
- and so on...
39
+
40
+
## Testing
41
+
42
+
While testing the code, if you're working with the frontend, it might be frustrating to run `npm run frontend` and `npm run backend` every time. Instead, use `npm run frontend:dev` to see real-time changes on port 3090 (really!).
43
+
44
+
> Note: You must run `npm run frontend` once before you can use `npm run frontend:dev`
45
+
46
+
### How?
47
+
48
+
-`git add *` adds all files to be committed.
49
+
-`git commit -m "name-of-your-commit"` creates a commit.
50
+
-`git push` uploads the changes.
51
+
52
+
Before doing all this, I recommend using GitHub Desktop to see what you've changed.
If `git commit` fails due to ESLint errors, read the error message and understand what's wrong. It could be an unused variable or other issues.
56
+
57
+
### Possible Various Problems
58
+
59
+
If you have the main branch with many commits and don't know what to do, follow this simple guide:
60
+
61
+
⚠️ Please do this only when you have no active PRs or when you're not working on the project:
62
+
63
+
1. Do a pull origin and in the terminal write `git log` to identify how many commits you are behind.
64
+
2. Use `git rebase -i HEAD~2`, where 2 represents the number of commits you need to go back. If you need to go back 100 commits, use `git rebase -i HEAD~100`.
65
+
3. In the editor, change the "pick" for the two commits to "drop," save with "esc," then type `:wq` and press "Enter."
0 commit comments