Skip to content

Commit

Permalink
docs: fix links to the website from docs and comments (#3081)
Browse files Browse the repository at this point in the history
  • Loading branch information
asafkorem committed Nov 16, 2021
1 parent cf95c1c commit db0ff85
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 30 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report---android.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ IMPORTANT: We will not be able to help out or provide proper analysis without th
### Device logs (adb logcat)
<!--
Paste *device* logs from the Android device/emulator - associated with the failing tests, under the "details" tag below.
Device logs can be obtained either by using `adb` (e.g. by running `adb logcat` while the test is running), or by running having Detox generate them as test artifacts (i.e. by providing the `--record-logs all` argument to the "detox test ..." command - see artifacts guide (https://wix.github.io/detox/docs/api/artifacts) for more info).
Device logs can be obtained either by using `adb` (e.g. by running `adb logcat` while the test is running), or by running having Detox generate them as test artifacts (i.e. by providing the `--record-logs all` argument to the "detox test ..." command - see artifacts guide (https://wix.github.io/Detox/docs/api/artifacts) for more info).
IMPORTANT: We will not be able to help out or provide proper analysis without these!
-->
Expand All @@ -64,7 +64,7 @@ IMPORTANT: We will not be able to help out or provide proper analysis without th

### Screenshots / Video

<!-- If applicable, add screenshots and videos to help explain your problem. To learn how to generate those, visit our test artifacts guide: https://wix.github.io/detox/docs/api/artifacts -->
<!-- If applicable, add screenshots and videos to help explain your problem. To learn how to generate those, visit our test artifacts guide: https://wix.github.io/Detox/docs/api/artifacts -->


### Environment
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report---ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ IMPORTANT! In case of a vague bug or a crash, please create an example project t

#### Screenshots / Video

<!-- If applicable, add screenshots and videos to help explain your problem. To learn how to generate those, visit our test artifacts guide: https://wix.github.io/detox/docs/api/artifacts -->
<!-- If applicable, add screenshots and videos to help explain your problem. To learn how to generate those, visit our test artifacts guide: https://wix.github.io/Detox/docs/api/artifacts -->


#### Environment
Expand All @@ -52,7 +52,7 @@ IMPORTANT! In case of a vague bug or a crash, please create an example project t

#### If you are experiencing a timeout in your test

- [ ] I have followed the instructions under [Identifying which synchronization mechanism causes us to wait too much](https://wix.github.io/detox/docs/troubleshooting/synchronization#identifying-which-synchronization-mechanism-causes-us-to-wait-too-much), I have read [synchronization debug documentation](https://github.com/wix/DetoxSync/blob/master/IdleStatusDocumentation.md) and am providing the relevant synchronization debug output below:
- [ ] I have followed the instructions under [Identifying which synchronization mechanism causes us to wait too much](https://wix.github.io/Detox/docs/troubleshooting/synchronization#identifying-which-synchronization-mechanism-causes-us-to-wait-too-much), I have read [synchronization debug documentation](https://github.com/wix/DetoxSync/blob/master/IdleStatusDocumentation.md) and am providing the relevant synchronization debug output below:

#### If you are seeing a Detox build problem (e.g. during `npm install`, not `detox build`)

Expand Down Expand Up @@ -84,7 +84,7 @@ IMPORTANT: We will not be able to help out or provide proper analysis without th

<!--
Paste *device* logs from the test device - associated with the failing tests, under the "details" tag below.
Device logs can be obtained by having Detox generate them as test artifacts (i.e. by providing the `--record-logs all` argument to the "detox test ..." command - see artifacts guide (https://wix.github.io/detox/docs/api/artifacts) for more info).
Device logs can be obtained by having Detox generate them as test artifacts (i.e. by providing the `--record-logs all` argument to the "detox test ..." command - see artifacts guide (https://wix.github.io/Detox/docs/api/artifacts) for more info).
IMPORTANT: We will not be able to help out or provide proper analysis without these!
-->
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ describe('Login flow', () => {
});
```

[Get started with Detox now!](https://wix.github.io/detox/docs/introduction/getting-started)
[Get started with Detox now!](https://wix.github.io/Detox/docs/introduction/getting-started)

## About

Expand Down Expand Up @@ -74,21 +74,21 @@ Future versions are most likely supported, but have not been tested yet. Please

## Get Started with Detox

Read the [Getting Started Guide](https://wix.github.io/detox/docs/introduction/getting-started) to get Detox running on your app in less than 10 minutes.
Read the [Getting Started Guide](https://wix.github.io/Detox/docs/introduction/getting-started) to get Detox running on your app in less than 10 minutes.

## Documents Site

Explore further about using Detox from our new **[documents site](https://wix.github.io/detox/docs)**.
Explore further about using Detox from our new **[documents site](https://wix.github.io/Detox/docs)**.

## Core Principles

We believe that the only way to address the core difficulties with mobile end-to-end testing is by rethinking some of the principles of the entire approach. See what Detox [does differently](https://wix.github.io/detox/docs/introduction/design-principles).
We believe that the only way to address the core difficulties with mobile end-to-end testing is by rethinking some of the principles of the entire approach. See what Detox [does differently](https://wix.github.io/Detox/docs/introduction/design-principles).

## Contributing to Detox

Detox has been open-source from the first commit. If you’re interested in helping out with our roadmap, please see issues tagged with the [<img src="docs/img/github-label-contributors.png">](https://github.com/wix/Detox/labels/user%3A%20looking%20for%20contributors) label. If you have encountered a bug or would like to suggest a new feature, please open an issue.

Dive into Detox core by reading the [Detox Contribution Guide](https://wix.github.io/detox/docs/guide/contributing).
Dive into Detox core by reading the [Detox Contribution Guide](https://wix.github.io/Detox/docs/guide/contributing).

## License

Expand Down
2 changes: 1 addition & 1 deletion detox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Graybox End-to-End Tests and Automation Library for Mobile
[![Build Status](https://img.shields.io/jenkins/s/http/jenkins-oss.wixpress.com:8080/job/multi-detox-master.svg)](https://jenkins-oss.wixpress.com/job/multi-detox-master/)
[![NPM Downloads](https://img.shields.io/npm/dm/detox.svg?style=flat)](https://www.npmjs.com/package/detox)

For more information [Read The Docs](https://wix.github.io/detox/docs).
For more information [Read The Docs](https://wix.github.io/Detox/docs).
10 changes: 5 additions & 5 deletions detox/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ declare global {
/**
* Launch the app.
*
* <p>For info regarding launch arguments, refer to the [dedicated guide](https://wix.github.io/detox/docs/api/launch-args).
* <p>For info regarding launch arguments, refer to the [dedicated guide](https://wix.github.io/Detox/docs/api/launch-args).
*
* @example
* // Terminate the app and launch it again. If set to false, the simulator will try to bring app from background,
Expand All @@ -481,7 +481,7 @@ declare global {
* Access the user-defined launch-arguments predefined through static scopes such as the Detox configuration file and
* command-line arguments. This access allows - through dedicated methods, for both value-querying and
* modification (see {@link AppLaunchArgs}).
* Refer to the [dedicated guide](https://wix.github.io/detox/docs/api/launch-args) for complete details.
* Refer to the [dedicated guide](https://wix.github.io/Detox/docs/api/launch-args) for complete details.
*
* @example
* // With Detox being preconfigured statically to use these arguments in app launch:
Expand Down Expand Up @@ -1120,7 +1120,7 @@ declare global {
/**
* Sets a picker view’s column to the given value. This function supports both date pickers and general picker views. (iOS Only)
* Note: When working with date pickers, you should always set an explicit locale when launching your app in order to prevent flakiness from different date and time styles.
* See [here](https://wix.github.io/detox/docs/api/device-object-api#9-launch-with-a-specific-language-ios-only) for more information.
* See [here](https://wix.github.io/Detox/docs/api/device-object-api#9-launch-with-a-specific-language-ios-only) for more information.
*
* @param column number of datepicker column (starts from 0)
* @param value string value in set column (must be correct)
Expand Down Expand Up @@ -1164,7 +1164,7 @@ declare global {

/**
* Takes a screenshot of the element and schedules putting it in the artifacts folder upon completion of the current test.
* For more information, see {@link https://wix.github.io/detox/docs/api/screenshots#element-level-screenshots}
* For more information, see {@link https://wix.github.io/Detox/docs/api/screenshots#element-level-screenshots}
* @param {string} name for the screenshot artifact
* @returns {Promise<string>} a temporary path to the screenshot.
* @example
Expand Down Expand Up @@ -1367,7 +1367,7 @@ declare global {
delete?: boolean;
/**
* Arguments to pass-through into the app.
* Refer to the [dedicated guide](https://wix.github.io/detox/docs/api/launch-args) for complete details.
* Refer to the [dedicated guide](https://wix.github.io/Detox/docs/api/launch-args) for complete details.
*/
launchArgs?: Record<string, any>;
/**
Expand Down
2 changes: 1 addition & 1 deletion detox/local-cli/utils/warnings.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const DETOX_ARGV_OVERRIDE_NOTICE = `
debugging flags and features, to speed up your investigation
and collect additional test artifacts. For more details, see:
https://wix.github.io/detox/docs/api/matchers/detox-cli#detox_argv_override
https://wix.github.io/Detox/docs/api/matchers/detox-cli#detox_argv_override
`;

Expand Down
2 changes: 1 addition & 1 deletion detox/runners/jest/DetoxAdapterImpl.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class DetoxAdapterImpl {
'While Detox CLI supports "-R <N>, --retries <N>" mechanism, ' +
'this outdated Jest integration does not — expect artifacts issues. ' +
'Please migrate to the new Jest Circus integration.\n\n' +
'See: https://wix.github.io/detox/docs/api/guide/jest\n');
'See: https://wix.github.io/Detox/docs/api/guide/jest\n');
}

this.detox = detox;
Expand Down
2 changes: 1 addition & 1 deletion detox/src/errors/DetoxRuntimeError.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ describe('DetoxRuntimeError', () => {
'\nExpected to get an object of type: { title: string; fullName: string; status: "running" | "passed" | "failed"; }',
hint: 'Maybe you are still using an old undocumented signature detox.beforeEach(string, string, string) in init.js ?' +
'\nSee the article for the guidance: ' +
'https://wix.github.io/detox/docs/api/test-lifecycle',
'https://wix.github.io/Detox/docs/api/test-lifecycle',
debugInfo: `testSummary was: ${JSON.stringify('test name')}`,
}),
});
Expand Down
2 changes: 1 addition & 1 deletion detox/src/errors/DetoxRuntimeErrorComposer.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class DetoxRuntimeErrorComposer {
'\nExpected to get an object of type: { title: string; fullName: string; status: "running" | "passed" | "failed"; }',
hint: 'Maybe you are still using an old undocumented signature detox.beforeEach(string, string, string) in init.js ?' +
'\nSee the article for the guidance: ' +
'https://wix.github.io/detox/docs/api/test-lifecycle' +
'https://wix.github.io/Detox/docs/api/test-lifecycle' +
'\ntestSummary was: ',
debugInfo: testSummary,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ exports[`DetoxRuntimeError should be created with message with hint and debug in
Expected to get an object of type: { title: string; fullName: string; status: "running" | "passed" | "failed"; }
HINT: Maybe you are still using an old undocumented signature detox.beforeEach(string, string, string) in init.js ?
See the article for the guidance: https://wix.github.io/detox/docs/api/test-lifecycle
See the article for the guidance: https://wix.github.io/Detox/docs/api/test-lifecycle
testSummary was: "test name"]
`;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ exports[`DetoxRuntimeErrorComposer invalidTestSummary - afterEach 1`] = `
Expected to get an object of type: { title: string; fullName: string; status: "running" | "passed" | "failed"; }
HINT: Maybe you are still using an old undocumented signature detox.beforeEach(string, string, string) in init.js ?
See the article for the guidance: https://wix.github.io/detox/docs/api/test-lifecycle
See the article for the guidance: https://wix.github.io/Detox/docs/api/test-lifecycle
testSummary was:
{
Expand All @@ -49,7 +49,7 @@ exports[`DetoxRuntimeErrorComposer invalidTestSummary - afterEach 2`] = `
Expected to get an object of type: { title: string; fullName: string; status: "running" | "passed" | "failed"; }
HINT: Maybe you are still using an old undocumented signature detox.beforeEach(string, string, string) in init.js ?
See the article for the guidance: https://wix.github.io/detox/docs/api/test-lifecycle
See the article for the guidance: https://wix.github.io/Detox/docs/api/test-lifecycle
testSummary was:
{
Expand All @@ -64,7 +64,7 @@ exports[`DetoxRuntimeErrorComposer invalidTestSummary - beforeEach 1`] = `
Expected to get an object of type: { title: string; fullName: string; status: "running" | "passed" | "failed"; }
HINT: Maybe you are still using an old undocumented signature detox.beforeEach(string, string, string) in init.js ?
See the article for the guidance: https://wix.github.io/detox/docs/api/test-lifecycle
See the article for the guidance: https://wix.github.io/Detox/docs/api/test-lifecycle
testSummary was:
deviceName]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ exports[`failedToReachTheApp .evenThoughAppWasLaunched() 1`] = `
HINT:
The test app might have crashed prematurely, or has had trouble setting up the connection.
Refer to our troubleshooting guide, for full details: https://wix.github.io/detox/docs/troubleshooting/running-tests#tests-execution-hangs
Refer to our troubleshooting guide, for full details: https://wix.github.io/Detox/docs/troubleshooting/running-tests#tests-execution-hangs
]
`;

Expand All @@ -16,7 +16,7 @@ exports[`failedToReachTheApp .maybeAppWasNotLaunched(action) 1`] = `
HINT:
Have you forgotten to call 'device.launchApp()' in the beginning of your test?
Refer to our troubleshooting guide, for full details: https://wix.github.io/detox/docs/troubleshooting/running-tests#tests-execution-hangs
Refer to our troubleshooting guide, for full details: https://wix.github.io/Detox/docs/troubleshooting/running-tests#tests-execution-hangs
---
The following package could not be delivered:
Expand Down
2 changes: 1 addition & 1 deletion detox/src/errors/longreads/failedToReachTheApp.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const DetoxRuntimeError = require('../DetoxRuntimeError');

const message = 'Detox can\'t seem to connect to the test app(s)!';
const troubleshootingRefMessage = 'Refer to our troubleshooting guide, for full details: https://wix.github.io/detox/docs/troubleshooting/running-tests#tests-execution-hangs';
const troubleshootingRefMessage = 'Refer to our troubleshooting guide, for full details: https://wix.github.io/Detox/docs/troubleshooting/running-tests#tests-execution-hangs';

const hintMaybeNotLaunched = `\
Have you forgotten to call 'device.launchApp()' in the beginning of your test?
Expand Down
4 changes: 2 additions & 2 deletions detox/src/ios/expectTwo.js
Original file line number Diff line number Diff line change
Expand Up @@ -656,11 +656,11 @@ class IosExpect {
}

function throwMatcherError(param) {
throw new Error(`${param} is not a Detox matcher. More about Detox matchers here: https://wix.github.io/detox/docs/api/matchers`);
throw new Error(`${param} is not a Detox matcher. More about Detox matchers here: https://wix.github.io/Detox/docs/api/matchers`);
}

function throwElementError(param) {
throw new Error(`${param} is not a Detox element. More about Detox elements here: https://wix.github.io/detox/docs/api/matchers`);
throw new Error(`${param} is not a Detox element. More about Detox elements here: https://wix.github.io/Detox/docs/api/matchers`);
}

module.exports = IosExpect;
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const config = {
onBrokenMarkdownLinks: 'warn',
favicon: '/img/favicon.ico',
organizationName: 'wix',
projectName: 'detox',
projectName: 'Detox',

presets: [
[
Expand Down

0 comments on commit db0ff85

Please sign in to comment.