docs: update the hyperlink for setting-up-the-dev-environment.md #4600
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asafkorem
requested changes
Oct 10, 2024
| @@ -4,7 +4,7 @@ This document guides you through setting up your development environment to star | |||
|
|
|||
| :::important Prerequisites | |||
|
|
|||
| Please complete our [Introductory environment setup](introduction/environment-setup.md) guide before proceeding. This ensures you have the necessary tools and dependencies installed in order to _run_ Detox tests, which is a fundamental step before being able to contribute to the project itself. | |||
| Please complete our [Introductory environment setup](../../introduction/environment-setup.md) guide before proceeding. This ensures you have the necessary tools and dependencies installed in order to _run_ Detox tests, which is a fundamental step before being able to contribute to the project itself. | |||
There was a problem hiding this comment.
I don't get it. What was broken? The link works (see the "Prerequisites" admonition)
https://wix.github.io/Detox/docs/contributing/code/setting-up-the-dev-environment
|
@kagrawal98 The documentation isn't intended to be read directly from the plain MD files (which probably have caused the linking issue you experienced). Please use the official docs site instead: https://wix.github.io/Detox/docs/contributing/code/setting-up-the-dev-environment/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the link to the introductory environment setup guide in the contributing documentation. The new link points to
../../introduction/environment-setup.mdinstead of the previous location.Motivation
This change ensures that contributors are directed to the correct and most up-to-date environment setup guide. Having the correct link is crucial for new contributors to properly set up their development environment before diving into Detox development.
Impact
This update improves the onboarding experience for new contributors by providing them with the correct resource for initial setup. It helps prevent confusion and ensures that all contributors start with a properly configured environment.