diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md rename to .github/pull_request_template.md diff --git a/documents/contributions/code_of_conduct.md b/CODE_OF_CONDUCT.md similarity index 96% rename from documents/contributions/code_of_conduct.md rename to CODE_OF_CONDUCT.md index 2bbade7abb..e28b3e9c08 100644 --- a/documents/contributions/code_of_conduct.md +++ b/CODE_OF_CONDUCT.md @@ -59,8 +59,8 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -https://t.me/proffapt. +reported to the community leaders responsible for enforcement here on GitHub or +on the official [Discord Server](https://discord.gg/uDyZ5Tzhct). All complaints will be reviewed and investigated promptly and fairly. 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) diff --git a/documents/contributions/contributor_guidelines.md b/CONTRIBUTING.md similarity index 97% rename from documents/contributions/contributor_guidelines.md rename to CONTRIBUTING.md index e3d4937c08..0993fd02e4 100644 --- a/documents/contributions/contributor_guidelines.md +++ b/CONTRIBUTING.md @@ -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.* -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 -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 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) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index cb9ad4b042..0000000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -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) diff --git a/README.md b/README.md index a5172e13c0..4684f352fd 100644 --- a/README.md +++ b/README.md @@ -74,46 +74,45 @@
Getting Started - * [Docker Install](/documents/install/docker_install.md) - * [Linux Install](documents/install/linux_install.md) - * [Mac Install](documents/install/mac_install.md) - * [Windows Install](documents/install/windows_install.md) + * [Docker Install](/docs/install/docker_install.md) + * [Linux Install](docs/install/linux_install.md) + * [Mac Install](docs/install/mac_install.md) + * [Windows Install](docs/install/windows_install.md)
General Information - * [Project Origin](documents/general_info/project_origin.md) - * [Multilingual Information](documents/general_info/multilingual_information.md) - * [Roadmap](documents/general_info/roadmap.md) - * [Tech Stack](documents/general_info/tech_stack.md) + * [Code of Conduct](CODE_OF_CONDUCT.md) + * [Project Origin](docs/general_info/project_origin.md) + * [Multilingual Information](docs/general_info/multilingual_information.md) + * [Roadmap](docs/general_info/roadmap.md) + * [Tech Stack](docs/general_info/tech_stack.md) * [Changelog](CHANGELOG.md) - * [Bing Jailbreak Info](documents/general_info/bing_jailbreak_info.md) + * [Bing Jailbreak Info](docs/general_info/bing_jailbreak_info.md)
Features - * [User Auth System](documents/features/user_auth_system.md) - * [Proxy](documents/features/proxy.md) + * [User Auth System](docs/features/user_auth_system.md) + * [Proxy](docs/features/proxy.md)
Cloud Deployment - * [Heroku](documents/deployment/heroku.md) + * [Heroku](docs/deployment/heroku.md)
Contributions - * [Code of Conduct](documents/contributions/code_of_conduct.md) - * [Contributor Guidelines](documents/contributions/contributor_guidelines.md) - * [Documentation Guidelines](documents/contributions/documentation_guidelines.md) - * [Code Standards and Conventions](documents/contributions/coding_conventions.md) - * [Testing](documents/contributions/testing.md) + * [Contributor Guidelines](CONTRIBUTING.md) + * [Documentation Guidelines](docs/contributions/documentation_guidelines.md) + * [Code Standards and Conventions](docs/contributions/coding_conventions.md) + * [Testing](docs/contributions/testing.md) * [Security](SECURITY.md) - * [Contributors](CONTRIBUTORS.md) * [Trello Board](https://trello.com/b/17z094kq/chatgpt-clone)
@@ -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. -- 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 --- diff --git a/SECURITY.md b/SECURITY.md index 717834d657..d478fbf09e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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 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** - https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html + +## + +## [Go Back to ReadMe](README.md) diff --git a/documents/contributions/coding_conventions.md b/docs/contributions/coding_conventions.md similarity index 99% rename from documents/contributions/coding_conventions.md rename to docs/contributions/coding_conventions.md index 9f6a722cdb..d98b2dff86 100644 --- a/documents/contributions/coding_conventions.md +++ b/docs/contributions/coding_conventions.md @@ -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. +## + +## [Go Back to ReadMe](../../README.md) \ No newline at end of file diff --git a/documents/contributions/documentation_guidelines.md b/docs/contributions/documentation_guidelines.md similarity index 100% rename from documents/contributions/documentation_guidelines.md rename to docs/contributions/documentation_guidelines.md diff --git a/documents/contributions/testing.md b/docs/contributions/testing.md similarity index 100% rename from documents/contributions/testing.md rename to docs/contributions/testing.md diff --git a/documents/deployment/heroku.md b/docs/deployment/heroku.md similarity index 100% rename from documents/deployment/heroku.md rename to docs/deployment/heroku.md diff --git a/documents/dev/Dockerfile-app b/docs/dev/Dockerfile-app similarity index 100% rename from documents/dev/Dockerfile-app rename to docs/dev/Dockerfile-app diff --git a/documents/dev/README.md b/docs/dev/README.md similarity index 100% rename from documents/dev/README.md rename to docs/dev/README.md diff --git a/documents/dev/eslintrc-stripped.js b/docs/dev/eslintrc-stripped.js similarity index 100% rename from documents/dev/eslintrc-stripped.js rename to docs/dev/eslintrc-stripped.js diff --git a/documents/dev/meilisearch.yml b/docs/dev/meilisearch.yml similarity index 100% rename from documents/dev/meilisearch.yml rename to docs/dev/meilisearch.yml diff --git a/documents/features/plugins/google_search.md b/docs/features/plugins/google_search.md similarity index 100% rename from documents/features/plugins/google_search.md rename to docs/features/plugins/google_search.md diff --git a/documents/features/proxy.md b/docs/features/proxy.md similarity index 100% rename from documents/features/proxy.md rename to docs/features/proxy.md diff --git a/documents/features/user_auth_system.md b/docs/features/user_auth_system.md similarity index 100% rename from documents/features/user_auth_system.md rename to docs/features/user_auth_system.md diff --git a/documents/general_info/bing_jailbreak_info.md b/docs/general_info/bing_jailbreak_info.md similarity index 100% rename from documents/general_info/bing_jailbreak_info.md rename to docs/general_info/bing_jailbreak_info.md diff --git a/documents/general_info/multilingual_information.md b/docs/general_info/multilingual_information.md similarity index 100% rename from documents/general_info/multilingual_information.md rename to docs/general_info/multilingual_information.md diff --git a/documents/general_info/project_origin.md b/docs/general_info/project_origin.md similarity index 100% rename from documents/general_info/project_origin.md rename to docs/general_info/project_origin.md diff --git a/documents/general_info/roadmap.md b/docs/general_info/roadmap.md similarity index 100% rename from documents/general_info/roadmap.md rename to docs/general_info/roadmap.md diff --git a/documents/general_info/tech_stack.md b/docs/general_info/tech_stack.md similarity index 100% rename from documents/general_info/tech_stack.md rename to docs/general_info/tech_stack.md diff --git a/documents/install/docker_install.md b/docs/install/docker_install.md similarity index 100% rename from documents/install/docker_install.md rename to docs/install/docker_install.md diff --git a/documents/install/linux_install.md b/docs/install/linux_install.md similarity index 97% rename from documents/install/linux_install.md rename to docs/install/linux_install.md index 36f8fe5569..b535f95a6c 100644 --- a/documents/install/linux_install.md +++ b/docs/install/linux_install.md @@ -65,7 +65,8 @@ sudo apt-get install -y nodejs - Driver = Node.js / Version = 4.1 or 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 diff --git a/documents/install/mac_install.md b/docs/install/mac_install.md similarity index 100% rename from documents/install/mac_install.md rename to docs/install/mac_install.md diff --git a/documents/install/windows_install.md b/docs/install/windows_install.md similarity index 99% rename from documents/install/windows_install.md rename to docs/install/windows_install.md index cf08f9377a..1b98d654c9 100644 --- a/documents/install/windows_install.md +++ b/docs/install/windows_install.md @@ -1,7 +1,7 @@ # Windows Install ### Recommended: -### **[Docker](docker.md)** +### **[Docker](docker_install.md)** or ### **[Automated Installer (Windows)](https://github.com/fuegovic/chatgpt-clone-local-installer)** (Includes a Startup and Update Utility)