LibreChat/documents/contributions/documentation_guidelines.md

# Documentation Guidelines

- ## ⚠️Keep it organized and structured⚠️
 - For new features, create new documents and place them in the appropriate folder(s)
 - 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 new documents
 - 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

##

## [Go Back to ReadMe](../../README.md)
-												update documentation structure (#220)

* documentation refactor

* Update README.md

* Delete README.MD.md

* Delete LOCAL_INSTALL.md

* Rename LICENSE.MD.md to LICENSE.MD

* Update LICENSE.md

* Delete LICENSE.MD

* Rename CONTRIBUTORS.MD.md to CONTRIBUTORS.md

* Rename CHANGELOG.MD.md to CHANGELOG.md

* new documents layout

* Update README.md

* Rename mac_install (1).md to mac_install.md

* Rename docker_install.md to docker_install.md

* Rename linux_install.md to linux_install.md

* Update and rename mac_install.md to mac_install.md

* Rename windows_install.md to windows_install.md

* Update docker_install.md

* Update linux_install.md

* Update mac_install.md

* Update windows_install.md

* Update windows_install.md

* Update linux_install.md

* Update tech_stack.md

* Update roadmap.md

* Update project_origin.md

* Update bing_jailbreak_info.md

* Update user_auth_system.md

* Update proxy.md

* Update google_search.md

* Update heroku.md

* Update testing.md

* Update pull_request_template.md

* Update documentation_guidelines.md

* Update contributor_guidelines.md

* Update code_of_conduct.md

* Update README.md

* Update README.md

* Update README.md

* Update roadmap.md

* Update tech_stack.md

* Update feature_request_template.md

* Update bug_report_template.md

* Update custom_issue_template.md

* Update README.md

fix redirect

* Update README.md

dynamic toc

* Update README.md

hide plugins section for now

* Update README.md

removed plugins from TOC

* Update README.md

* Update README.md

* Update documentation_guidelines.md

* Update documentation_guidelines.md

* Update documentation_guidelines.md

directives update

* Update README.md

update shortcut

* Update CHANGELOG.md

* Update roadmap.md

add public trello link

* Update linux_install.md
											
										
										
											2023-05-09 13:47:14 -04:00
+								# Documentation Guidelines
 								- ## ⚠️Keep it organized and structured⚠️
 								 - For new features, create new documents and place them in the appropriate folder(s)
 								 - 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 new documents
 								 - 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
 								##
 								## [Go Back to ReadMe](../../README.md)