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
This commit is contained in:
Fuegovic 2023-07-01 20:11:37 -04:00 committed by GitHub
parent d7270a1676
commit df2a68e1e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
75 changed files with 1129 additions and 209 deletions

View file

@ -1,9 +1,44 @@
# Documentation Guidelines
- ## ⚠Keep it organized and structured⚠
- 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
- 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**
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>