LibreChat/docs/contributions/documentation_guidelines.md
Fuegovic 5e3809f22c
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

755 B

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
  • Add a shortcut that point back to the README.MD in the bottom of new documents (look at other docs for example)
  • 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

Go Back to ReadMe