Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Docs: assets clean up (#598)

Browse source 
* Update ngrok.md

* Update linode.md

* Update cloudflare.md

* Update testing.md

* Update google_search.md

* Update introduction.md

* Update stable_diffusion.md

* Update wolfram.md

* docs: assets clean up
This commit is contained in:
Fuegovic 2023-07-06 17:41:22 -04:00 • committed by GitHub
parent fabd85ff40
commit 69d192bac3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
46 changed files with 102 additions and 110 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/contributions/documentation_guidelines.md
View file

@ -16,17 +16,17 @@ This document explains how to write and format documentation for LibreChat.
- 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.
- Use relative paths for 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`
- All assets should be uploaded in the document from GitHub's webui:
- **Before submitting a PR, double-check on GitHub that everything is properly displayed and that all links work correctly.**
![image](https://github.com/danny-avila/LibreChat/assets/32828263/4f138ab4-31a5-4fae-a459-5335e5ff25a8)
## Tips
- You can check the code of this document to see how it works.
- You can run MKDocs locally to test bigger documentation changes
@ -36,9 +36,9 @@ This document explains how to write and format documentation for LibreChat.
### Example of HTML image embedding:
<p align="center">
<a href="https://discord.gg/NGaa9RPCft">
<img src="../assets/LibreChat.svg" height="128">
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/45890a7c-5b8d-4650-a6e0-aa5d7e4951c3" height="128" width="128">
</a>
<a href="https://librechat.ai">
<h2 align="center">LibreChat</h2>
<h3 align="center">LibreChat</h3>
</a>
</p>
</p>