docs: added suggestions

docs/contributing.md

@@ -1,10 +1,8 @@
 # Contributing to Detox
 
-## Call for Contributions
-
 Detox, an open-source project, greatly values community involvement. Whether you're a mobile developer, QA specialist, or an open source enthusiast, your contribution could significantly enhance the reliability, user experience, and development process of mobile applications.
 
-### Our Code of Conduct
+## Our Code of Conduct
 
 To ensure an inclusive, safe environment for all contributors, we adhere to the [Contributor Covenant code of conduct]. This well-recognized code provides clear guidelines for respectful behavior.
 

docs/contributing/code-of-conduct.md

@@ -16,7 +16,7 @@ For answers to common questions about this code of conduct, see the FAQ at
 :::
 
 Our community is dedicated to providing a safe and inclusive environment for all contributors.
-To ensure this, we have adopted the **[Contributor Covenant]*- code of conduct.
+To ensure this, we have adopted the **[Contributor Covenant]** code of conduct.
 This widely recognized and respected code of conduct sets clear guidelines for behavior, and it's easy for everyone to understand and follow.
 
 By participating in the Detox community, you agree to abide by the terms of this code of conduct.

docs/contributing/code/example-projects.md

@@ -4,7 +4,7 @@ Explore various example projects hosted in this monorepo to understand real-worl
 
 - `examples/demo-react-native-jest`: Demonstrates Detox usage in a React Native app project.
 - `examples/demo-native-ios`: Illustrates Detox usage in a pure-native iOS app.
-- `examples/demo-native-android` (broken): Demonstrates Detox usage in a pure-native Android app.
+- `examples/demo-native-android` <span style={{color: 'red'}}>(broken)</span>: Demonstrates Detox usage in a pure-native Android app.
 - `examples/demo-pure-native-android`: Highlights the _pure_ [Detox-Native](https://github.com/wix/Detox/tree/master/detox-native/README.md) project.
 
 To run end-to-end tests associated with these projects, refer to the [project-specific](https://github.com/wix/Detox/tree/master/examples) READMEs.

docs/contributing/code/overview.md

@@ -1,3 +1,7 @@
+---
+sidebar_label: Overview
+---
+
 # Code Changes Overview
 
 Welcome to the code changes section! As a contributor, it's essential to understand the project's goals and adhere to its code of conduct. Before contributing, please review any existing issues related to your work, ensure your code is well-documented, and has adequate test coverage. It's also important that your code is compatible with the project's supported platforms and their versions.

docs/contributing/code/setting-up-the-dev-environment.md

@@ -34,22 +34,34 @@ lerna bootstrap
 
 ### React-Native CLI
 
+[react-native-cli] is a command line interface for React Native.
+
 ```bash npm2yarn
 npm install react-native-cli --global
 ```
 
 ### Watchman
 
+[Watchman] is a tool by Facebook for watching changes in the filesystem.
+
 ```bash
 brew install watchman
 ```
 
 ### xcpretty
 
+[xcpretty] is a fast and flexible formatter for xcodebuild.
+
 ```bash
 gem install xcpretty
 ```
 
 ## Building and Testing
 
-Refer to the scripts `scripts/ci.ios.sh` and `scripts/ci.android.sh` to understand the build and test process. Ensure these scripts pass before submitting a pull request.
+Refer to the scripts `scripts/ci.ios.sh` and `scripts/ci.android.sh` to understand the build and test process.
+
+Before submitting a pull request, please ensure at a minimum that your code adheres to our linting standards and that all unit tests run successfully without any errors.
+
+[react-native-cli]: https://www.npmjs.com/package/react-native-cli
+[Watchman]: https://facebook.github.io/watchman/
+[xcpretty]: https://github.com/xcpretty/xcpretty

docs/contributing/code/submitting-pull-requests.md

@@ -37,9 +37,9 @@ Refer to the [Documentation Changes] page for guidelines.
 Write descriptive, meaningful commit messages that follow the **Conventional Commits** format, specifying the type of change, the scope, and a concise description. For example:
 
 ```plaintext
-fix(iOS): resolve crash on scrolling in iOS 17.0
-feat(Android): add new API for setting the device locale
-chore(tests): update unit tests for new utility function
+fix(ios): resolve crash on scrolling in iOS 17.0
+feat(android): add new API for setting the device locale
+test: update unit tests for new utility function
 ```
 
 More details on good commit messages can be found [here](https://www.conventionalcommits.org/en/v1.0.0/).

docs/contributing/feature-requests.md

@@ -2,11 +2,11 @@
 
 Open dialogue and feedback, particularly feature requests, play an invaluable role in open-source communities like Detox. They provide insights into user preferences and requirements, aiding in the refinement and enhancement of the project.
 
-Detox project provides various platforms for feedback: [GitHub Issues], [GitHub Discussions], and [Discord].
+Detox project provides various platforms for feedback: [GitHub Issues], [Twitter], and [Discord].
 
 Keep in mind that feedback is varied, including feature suggestions, improvements, identification of missing functionality, and support requests. Each type of feedback has a preferred method of submission.
 
-## Crafting Effective Feedback
+## Giving Feedback
 
 Follow these tips to deliver clear, actionable feedback:
 
@@ -15,12 +15,10 @@ Follow these tips to deliver clear, actionable feedback:
 - **Clarity and Respect:** Make your feedback specific, clear, and respectful, ensuring it is actionable for the maintainers.
 - **Guidelines:** Adhere to the below suggestions for each type of feedback.
 
-## Feature Suggestions
+## Suggesting Features
 
 When suggesting a new feature, remember to provide thorough information, such as examples, screenshots, and code snippets, to communicate your idea effectively.
 
-## Crafting Effective Feature Suggestions
-
 Just as in general feedback, make sure your feature request is:
 
 - **Specific:** Clearly describe the feature you wish to see implemented.
@@ -30,5 +28,5 @@ Just as in general feedback, make sure your feature request is:
 By making your feedback as clear and detailed as possible, you'll greatly assist the maintainers in understanding and potentially implementing your suggestion.
 
 [GitHub Issues]: https://github.com/wix/Detox/issues
-[GitHub Discussions]: https://github.com/wix/Detox/discussions
+[Twitter]: https://twitter.com/detoxe2e
 [Discord]: https://discord.gg/CkD5QKheF5

docs/contributing/questions/asking-questions.md

@@ -10,7 +10,7 @@ In case you're facing an issue, consider the following steps before posting a qu
 
 - **Suspect a bug?** Refer to our [Reporting Bugs] guide to determine if you've encountered a Detox bug and how to report it.
 - **Search** for existing answers that may have addressed your question already. [Below](#where-to-ask), we've listed the right platforms to ask (and search) questions.
-- Review our **documentation** thoroughly for any related information. Use the search bar on the top bar to streamline your search.
+- Review our **documentation** thoroughly for any related information. Use <a href="#" onClick={() => document.querySelector('.DocSearch-Button').click()}>the search bar</a> in the top right corner to streamline your search.
 
 If an existing answer doesn't fully address your question, feel free to ask a follow-up in the same thread if comment-enabled or create a new question, linking back to the original one if possible.
 
@@ -18,7 +18,7 @@ If an existing answer doesn't fully address your question, feel free to ask a fo
 
 If you can't find an answer to your question, you can ask it in the following ways:
 
-- **Discord**: Join our dedicated Discord server [here][Discord] to seek community assistance.
+- **Discord**: Join our dedicated [Discord server][Discord] to seek community assistance.
 - **Stack Overflow**: Tag your question with ["Detox" on Stack Overflow] to reach the right audience.
 - **GitHub**: Raise an issue on our [Detox repository].