Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-09-22 06:00:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
LibreChat/docs/contributions/documentation_guidelines.md
Fuegovic d437e4b8cd
update: "documents" folder to "docs" (#391) 
* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md

fix: Pull Request Template Location

* documents -> docs

* Update windows_install.md

Fix: Docker hyperlink

* Update linux_install.md

Fix: Layout (step 6)

* Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md

fix: Code of Conduct location according to GitHub's Guide

* Update CODE_OF_CONDUCT.md

Update: Contact info

* Update README.md

Update: Code of Conduct hyperlink in TOC

* Update CODE_OF_CONDUCT.md

Update: Link to ReadMe

* Update CONTRIBUTORS.md

update: add new name to the list

* Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md

fix: change location according to GitHub's standards

* Delete CONTRIBUTORS.md

delete: contributor.md from root (already present in readme)

* Update SECURITY.md

* Update CONTRIBUTING.md

Update discord link to point to rules

* Update README.md

Update discord link to point to rules

* Update README.md

fix: ToC
2023-05-27 07:03:28 -04:00

672 B
Raw Blame History

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 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