LibreChat/docs/contributions/documentation_guidelines.md

# Documentation Guidelines

This document explains how to write and format documentation for LibreChat.

## New Documents
- Use lowercase letters and underscores to name new documents (e.g. `documentation_guidelines.md`).
- For new features, create new documentation and place it in the relevant folder/sub-folder under [docs](../docs/).
  - If the feature adds new functionality, add it to the feature section of the main [README.md](../../README.md).
- When you create a new document, **add it to both table of contents:**
  - [README.md](../../README.md)
  - [mkdocs.yml](../../mkdocs.yml) 

## Formatting
- Use `#`, `##`, and `###` for headings and subheadings.
- Use `#` for the title of the document.
- Use `##` for the main sections of the document.
- Use `###` for the sub-sections within a section.
- Use `**` to make text bold to highlight important information (not in place of a heading).
- Use relative paths for images and links to other documents.
- You can use HTML to add more features to a document.

## Important Notes
- **⚠️Keep it organized and structured⚠️** 
- Do not add unrelated information to an existing document. Create a new one if needed.
- All assets go into [assets/docs](../assets/docs/).
  - The assets folder structure follows the same structure as the docs folder structure.
  - The assets should have the same name as your documents followed by `-` and a number (e.g. `documentation_guidelines-1.png`).
  - example: an image for this document should be `../assets/docs/contributions/documentation_guidelines-1.png`
- **Before submitting a PR, double-check on GitHub that everything is properly displayed and that all links work correctly.**
## Tips
- You can check the code of this document to see how it works. 
- You can run MKDocs locally to test bigger documentation changes
- You can ask GPT or Bing for help with proofreading, syntax, and markdown formatting. 
  
---
### Example of HTML image embedding:
<p align="center">
  <a href="https://discord.gg/NGaa9RPCft">
    <img src="../assets/LibreChat.svg" height="128">
  </a>
  <a href="https://librechat.ai">
    <h2 align="center">LibreChat</h2>
  </a>
</p>
-												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
											
										
										
											2023-06-11 11:18:32 -04:00
+								# Documentation Guidelines
-												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
-												Docs: updates & enhancements for MKDocs  (#555)

* Update documents for mkdocs compatibility

* documents update

* documents update

* Update README.md

* Update README.md

add link to "https://docs.librechat.ai" on the logo

* document updates

* docs - badge updates

* docs - badge updates

* docs - badge updates

* Update docker_install.md

* Update .env.example

update default MONGO_URI to port 27018 so local install can communicate with the docker db

* Update windows_install.md

fix typo
											
										
										
											2023-07-01 20:11:37 -04:00
+								This document explains how to write and format documentation for LibreChat.
 								## New Documents
 								- Use lowercase letters and underscores to name new documents (e.g. `documentation_guidelines.md`).
 								- For new features, create new documentation and place it in the relevant folder/sub-folder under [docs](../docs/).
 								  - If the feature adds new functionality, add it to the feature section of the main [README.md](../../README.md).
 								- When you create a new document, **add it to both table of contents:**
 								  - [README.md](../../README.md)
 								  - [mkdocs.yml](../../mkdocs.yml)
 								## Formatting
 								- Use `#`, `##`, and `###` for headings and subheadings.
 								- Use `#` for the title of the document.
 								- Use `##` for the main sections of the document.
 								- Use `###` for the sub-sections within a section.
 								- Use `**` to make text bold to highlight important information (not in place of a heading).
 								- Use relative paths for images and links to other documents.
 								- You can use HTML to add more features to a document.
 								## Important Notes
 								- **⚠️Keep it organized and structured⚠️**
 								- Do not add unrelated information to an existing document. Create a new one if needed.
 								- All assets go into [assets/docs](../assets/docs/).
 								  - The assets folder structure follows the same structure as the docs folder structure.
 								  - The assets should have the same name as your documents followed by `-` and a number (e.g. `documentation_guidelines-1.png`).
 								  - example: an image for this document should be `../assets/docs/contributions/documentation_guidelines-1.png`
 								- **Before submitting a PR, double-check on GitHub that everything is properly displayed and that all links work correctly.**
 								## Tips
 								- You can check the code of this document to see how it works.
 								- You can run MKDocs locally to test bigger documentation changes
 								- You can ask GPT or Bing for help with proofreading, syntax, and markdown formatting.
 								---
 								### Example of HTML image embedding:
 								<p align="center">
 								  <a href="https://discord.gg/NGaa9RPCft">
 								    <img src="../assets/LibreChat.svg" height="128">
 								  </a>
 								  <a href="https://librechat.ai">
 								    <h2 align="center">LibreChat</h2>
 								  </a>
 								</p>