mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 08:50:15 +01:00
51050cc4d3
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
2.5 KiB
2.5 KiB
| title | weight |
|---|---|
| 📝 Documentation Guidelines | -9 |
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.- If the feature adds new functionality, add it to the feature section of the main
README.mdas well as in../docs/index.md.
- If the feature adds new functionality, add it to the feature section of the main
- When you create a new document, you need to add it to two table of contents:
- in
README.md - and in the
index.mdfile in the folder where your doc is located
- in
Markdown 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 (do not use in place of a heading). - Use relative paths for links to other documents.
- You can use HTML to add more features to a document.
- By default the title indexed by mkdocs will be the first heading. You can override this by adding metadata at the top of your document:
---
title: Document Title
weight: 0
---
- Setting the weight in the document metadata will influence its position in the table of contents. Lowest weight are placed first. Not setting it will default to
0. When multiple docs have the same weight it sorts in alphabetical order.
Important Notes
- ⚠️Keep it organized and structured⚠️
- Do not add unrelated information to an existing document. Create a new one if needed.
- 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.
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.