mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-29 22:58:51 +01:00
docs: fix outdated references (#480)
* Update .env.example * Update README.md * Update bing_jailbreak_info.md * Update heroku.md * Update SECURITY.md * Update CONTRIBUTING.md * Update CODE_OF_CONDUCT.md * Update LICENSE.md * Update SECURITY.md * Update coding_conventions.md * Update documentation_guidelines.md * Update testing.md * Update heroku.md * Update google_search.md * Update introduction.md * Update make_your_own.md * Update stable_diffusion.md * Update wolfram.md * Update proxy.md * Update user_auth_system.md * Update bing_jailbreak_info.md * Update multilingual_information.md * Update project_origin.md * Update tech_stack.md * Update apis_and_tokens.md * Update docker_install.md * Update linux_install.md * Update mac_install.md * Update windows_install.md * Update install.js
This commit is contained in:
parent
3dadedaf69
commit
5e3809f22c
27 changed files with 172 additions and 248 deletions
|
|
@ -79,6 +79,7 @@ Defines Mongoose models to represent data entities and their relationships.
|
|||
- Use descriptive test case and function names to clearly express the test's purpose.
|
||||
- Document the code using JSDoc comments to provide clear explanations of functions, parameters, and return types. (WIP)
|
||||
|
||||
---
|
||||
|
||||
## React Client
|
||||
|
||||
|
|
@ -102,6 +103,6 @@ Use the conventions found in the `data-provider` directory for handling data ser
|
|||
|
||||
Use [Recoil](https://recoiljs.org/) for state management, but *DO NOT pollute the global state with unnecessary data*. Instead, use local state or props for data that is only used within a component or passed down from parent to child.
|
||||
|
||||
##
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
# Documentation Guidelines
|
||||
# Documentation Guidelines
|
||||
|
||||
- ## ⚠️Keep it organized and structured⚠️
|
||||
- For new features, create new documents and place them in the appropriate folder(s)
|
||||
- For new features, create new documentation and place it in the appropriate folder(s)
|
||||
- If the feature adds new functionality, it should be added to the feature section of the main Readme
|
||||
- When you create a new document, do not forget to add it to the table of content
|
||||
- Add a shortcut that point back to the [README.MD](../../README.md) in the bottom of new documents (look at other docs for example)
|
||||
- Use `#` / `##` / `###` for the different section of the doc
|
||||
- Do not add unrelated information to an existing document, create a new one if needed
|
||||
- For incremental updates, you need to update the main **README.MD** and **CHANGELOG.MD**
|
||||
- In the main README update the part where the last version is shown and the features section if needed
|
||||
- For incremental updates, you need to update the main **README.MD**
|
||||
|
||||
##
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Locally test the app during development
|
||||
# Locally test the app during development
|
||||
|
||||
### Run the app
|
||||
|
||||
|
|
@ -64,6 +64,6 @@ If everything goes well, you should see a `passed` message.
|
|||
|
||||
<img src="https://user-images.githubusercontent.com/22865959/235321489-9be48fd6-77d4-4e21-97ad-0254e140b934.png">
|
||||
|
||||
##
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue