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
This commit is contained in:
Fuegovic 2023-05-27 07:03:28 -04:00 committed by GitHub
parent f40a2f8ee8
commit d437e4b8cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
26 changed files with 34 additions and 57 deletions

View file

@ -59,8 +59,8 @@ representative at an online or offline event.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement here on GitHub or
https://t.me/proffapt. on the official [Discord Server](https://discord.gg/uDyZ5Tzhct).
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the
@ -129,4 +129,4 @@ https://www.contributor-covenant.org/translations.
## ##
## [Go Back to ReadMe](../../README.md) ## [Go Back to ReadMe](README.md)

View file

@ -12,11 +12,11 @@ If the feature you would like to contribute has not already received prior appro
*Please note that a pull request involving a feature that has not been reviewed and approved by the project maintainers may be rejected.* *Please note that a pull request involving a feature that has not been reviewed and approved by the project maintainers may be rejected.*
If you would like to discuss the changes you wish to make, join our [Discord community](https://discord.gg/NGaa9RPCft). If you would like to discuss the changes you wish to make, join our [Discord community](https://discord.gg/uDyZ5Tzhct).
## Our Standards ## Our Standards
Please read our [Coding Standards and Conventions](coding_conventions.md) before beginning on a contribution. Please read our [Coding Standards and Conventions](docs/contributions/coding_conventions.md) before beginning on a contribution.
Examples of behavior that contributes to creating a positive environment Examples of behavior that contributes to creating a positive environment
include: include:
@ -180,6 +180,6 @@ Apply the following naming conventions to branches, labels, and other Git-relate
## ##
## [Go Back to ReadMe](../../README.md) ## [Go Back to ReadMe](README.md)

View file

@ -1,26 +0,0 @@
# Contributors List
We appreciate all the contributors who helped make this project possible:
- danny-avila (Admin)
- wtlyu (Contributor)
- danorlando (Contributor)
- alfredo-f (Contributor)
- HyunggyuJang (Contributor)
- fuegovic (Contributor)
- DavidDev1334
- toordog (Contributor)
- heathriel (External Contributor)
- hackreactor-bot (Contributor)
- git-bruh (Contributor)
- zhangsean (Contributor)
- llk89 (Contributor)
- adamrb (Contributor)
If you have contributed to this project and would like to be added to the list of contributors, please submit a pull request updating this file with your name and GitHub username.
##
## [Go Back to ReadMe](README.md)

View file

@ -74,46 +74,45 @@
<details open> <details open>
<summary><strong>Getting Started</strong></summary> <summary><strong>Getting Started</strong></summary>
* [Docker Install](/documents/install/docker_install.md) * [Docker Install](/docs/install/docker_install.md)
* [Linux Install](documents/install/linux_install.md) * [Linux Install](docs/install/linux_install.md)
* [Mac Install](documents/install/mac_install.md) * [Mac Install](docs/install/mac_install.md)
* [Windows Install](documents/install/windows_install.md) * [Windows Install](docs/install/windows_install.md)
</details> </details>
<details> <details>
<summary><strong>General Information</strong></summary> <summary><strong>General Information</strong></summary>
* [Project Origin](documents/general_info/project_origin.md) * [Code of Conduct](CODE_OF_CONDUCT.md)
* [Multilingual Information](documents/general_info/multilingual_information.md) * [Project Origin](docs/general_info/project_origin.md)
* [Roadmap](documents/general_info/roadmap.md) * [Multilingual Information](docs/general_info/multilingual_information.md)
* [Tech Stack](documents/general_info/tech_stack.md) * [Roadmap](docs/general_info/roadmap.md)
* [Tech Stack](docs/general_info/tech_stack.md)
* [Changelog](CHANGELOG.md) * [Changelog](CHANGELOG.md)
* [Bing Jailbreak Info](documents/general_info/bing_jailbreak_info.md) * [Bing Jailbreak Info](docs/general_info/bing_jailbreak_info.md)
</details> </details>
<details> <details>
<summary><strong>Features</strong></summary> <summary><strong>Features</strong></summary>
* [User Auth System](documents/features/user_auth_system.md) * [User Auth System](docs/features/user_auth_system.md)
* [Proxy](documents/features/proxy.md) * [Proxy](docs/features/proxy.md)
</details> </details>
<details> <details>
<summary><strong>Cloud Deployment</strong></summary> <summary><strong>Cloud Deployment</strong></summary>
* [Heroku](documents/deployment/heroku.md) * [Heroku](docs/deployment/heroku.md)
</details> </details>
<details> <details>
<summary><strong>Contributions</strong></summary> <summary><strong>Contributions</strong></summary>
* [Code of Conduct](documents/contributions/code_of_conduct.md) * [Contributor Guidelines](CONTRIBUTING.md)
* [Contributor Guidelines](documents/contributions/contributor_guidelines.md) * [Documentation Guidelines](docs/contributions/documentation_guidelines.md)
* [Documentation Guidelines](documents/contributions/documentation_guidelines.md) * [Code Standards and Conventions](docs/contributions/coding_conventions.md)
* [Code Standards and Conventions](documents/contributions/coding_conventions.md) * [Testing](docs/contributions/testing.md)
* [Testing](documents/contributions/testing.md)
* [Security](SECURITY.md) * [Security](SECURITY.md)
* [Contributors](CONTRIBUTORS.md)
* [Trello Board](https://trello.com/b/17z094kq/chatgpt-clone) * [Trello Board](https://trello.com/b/17z094kq/chatgpt-clone)
</details> </details>
@ -130,7 +129,7 @@ Please read the documentation before you do!
For new features, components, or extensions, please open an issue and discuss before sending a PR. For new features, components, or extensions, please open an issue and discuss before sending a PR.
- Join the [Discord community](https://discord.gg/NGaa9RPCft) - Join the [Discord community](https://discord.gg/uDyZ5Tzhct)
This project exists in its current state thanks to all the people who contribute This project exists in its current state thanks to all the people who contribute
--- ---

View file

@ -46,10 +46,10 @@ We would like to express our gratitude to the security researchers and community
We do not currently have a bug bounty program in place. However, we welcome and appreciate any security-related contributions through pull requests (PRs) that address vulnerabilities in our codebase. We do not currently have a bug bounty program in place. However, we welcome and appreciate any security-related contributions through pull requests (PRs) that address vulnerabilities in our codebase.
We believe in the power of collaboration to improve the security of our project and invite you to join us in making it more robust. We believe in the power of collaboration to improve the security of our project and invite you to join us in making it more robust.
##
## [Go Back to ReadMe](README.md)
**Reference** **Reference**
- https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html - https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html
##
## [Go Back to ReadMe](README.md)

View file

@ -102,3 +102,6 @@ Use the conventions found in the `data-provider` directory for handling data ser
Use [Recoil](https://recoiljs.org/) for state management, but *DO NOT pollute the global state with unnecessary data*. Instead, use local state or props for data that is only used within a component or passed down from parent to child. Use [Recoil](https://recoiljs.org/) for state management, but *DO NOT pollute the global state with unnecessary data*. Instead, use local state or props for data that is only used within a component or passed down from parent to child.
##
## [Go Back to ReadMe](../../README.md)

View file

@ -65,7 +65,8 @@ sudo apt-get install -y nodejs
- Driver = Node.js / Version = 4.1 or later. - Driver = Node.js / Version = 4.1 or later.
- Copy the connection string and save it somewhere (you will need it later). - Copy the connection string and save it somewhere (you will need it later).
## 6. Get your OpenAI API key - Visit https://platform.openai.com/account/api-keys and save your API key somewhere safe (you will need it later) ## 6. Get your OpenAI API key
- Visit https://platform.openai.com/account/api-keys and save your API key somewhere safe (you will need it later)
## 7. Get your Bing Access Token ## 7. Get your Bing Access Token

View file

@ -1,7 +1,7 @@
# Windows Install # Windows Install
### Recommended: ### Recommended:
### **[Docker](docker.md)** ### **[Docker](docker_install.md)**
or or
### **[Automated Installer (Windows)](https://github.com/fuegovic/chatgpt-clone-local-installer)** ### **[Automated Installer (Windows)](https://github.com/fuegovic/chatgpt-clone-local-installer)**
(Includes a Startup and Update Utility) (Includes a Startup and Update Utility)