docs: more cleanup

This commit is contained in:
Jennifer Shehane
2017-06-15 17:05:09 -04:00
parent 1223f2e42b
commit c0e9b2b9ba
11 changed files with 2176 additions and 18 deletions
+1 -1
View File
@@ -40,7 +40,7 @@ guides:
# creating-fixtures: creating-fixtures.html
# best-practices: best-practices.html
# anti-patterns: anti-patterns.html
cypress-api-design: cypress-api-design.html
# cypress-api-design: cypress-api-design.html
userland-extensions: userland-extensions.html
known-issues: known-issues.html
# contributing: contributing.html
@@ -5,7 +5,7 @@ comments: false
# Overview
{% url "Code" https://github.com/cypress-io/cypress-example-kitchensink %}
{% url "https://github.com/cypress-io/cypress-example-kitchensink" https://github.com/cypress-io/cypress-example-kitchensink %}
This is an example app is used to showcase every command available in Cypress.
@@ -5,7 +5,7 @@ comments: false
# Overview
{% url "Code" https://github.com/cypress-io/cypress-example-phonecat %}
{% url "https://github.com/cypress-io/cypress-example-phonecat" https://github.com/cypress-io/cypress-example-phonecat %}
This tests the {% url "original Angular Phonecat example app" https://github.com/angular/angular-phonecat %} using Cypress.
@@ -3,19 +3,23 @@ title: PieChopper
comments: false
---
[Code](https://github.com/cypress-io/cypress-example-piechopper)
# Overview
This is a single page application with a decent amount of features. The [tests](https://github.com/cypress-io/cypress-example-piechopper/blob/master/cypress/integration/app_spec.js) involve a lot of form submissions.
{% url "https://github.com/cypress-io/cypress-example-piechopper" https://github.com/cypress-io/cypress-example-piechopper %}
- Test mobile responsive views using `cy.viewport()`
This is a single page application with a decent amount of features. The tests involve a lot of form submissions.
- Test mobile responsive views using {% url `cy.viewport()` viewport %}
- Test that the app scrolls correctly
- Check checkboxes using `cy.check()`
- Stub responses from our backend using `cy.route()`
- Check checkboxes using {% url `cy.check()` check %}
- Stub responses from our backend using {% url `cy.route()` route %}
![piechopper-gif](https://cloud.githubusercontent.com/assets/1268976/12985444/ad14159c-d0c0-11e5-8e50-2b64a1d389ac.gif)
# Stack
Stack | -
-- | --
Frontend | [Angular](https://angularjs.org/)
Backend | [Node](https://nodejs.org/)
CI | [TravisCI](https://travis-ci.org/), [CircleCI](https://circleci.com)
Frontend | {% url "Angular" https://angularjs.org/ %}
Backend | {% url "Node" https://nodejs.org/ %}
CI | {% url "TravisCI" https://travis-ci.org/ %}, {% url "CircleCI" https://circleci.com %}
@@ -5,7 +5,7 @@ comments: false
# Overview
{% url "Code" https://github.com/cypress-io/cypress-example-todomvc %}
{% url "https://github.com/cypress-io/cypress-example-todomvc" https://github.com/cypress-io/cypress-example-todomvc %}
This repo compares {% url "Cypress Tests" https://github.com/cypress-io/cypress-example-todomvc/blob/master/cypress/integration/app_spec.js %} to {% url "official TodoMVC Tests" https://github.com/tastejs/todomvc/blob/master/tests/test.js %}. This gives you a good comparison of writing and running tests in Cypress versus vanilla Selenium.
File diff suppressed because it is too large Load Diff
@@ -51,7 +51,7 @@ it('uses modules', function () {
It's still useful to load a setup files before your test code. If you are setting Cypress defaults or utilizing custom Cypress commands, instead of needing to import/require those defaults/commands in every test file, you can use the {% url `supportFile` configuration#Folders %} configuration option.
{% url `supportFile` configuration#Folders %} is a path to a file to include before your test files. By default, {% url `supportFile` configuration#Folders %} is set to look for one of the following files:
To include code before your test files, set the {% url `supportFile` configuration#Folders %} path. By default, {% url `supportFile` configuration#Folders %} is set to look for one of the following files:
* `cypress/support/index.js`
* `cypress/support/index.coffee`
@@ -9,7 +9,7 @@ comments: false
Run multiple spec files concurrently.
https://github.com/kensho/multi-cypress
{% url "https://github.com/kensho/multi-cypress" https://github.com/kensho/multi-cypress %}
# Typescript
@@ -17,4 +17,4 @@ https://github.com/kensho/multi-cypress
Typescript typings for most Cypress API commands.
https://github.com/StackVista/typed-cypress
{% url "https://github.com/StackVista/typed-cypress" https://github.com/StackVista/typed-cypress %}
@@ -38,7 +38,7 @@ Once you're logged into the {% url 'Dashboard' https://on.cypress.io/dashboard %
## {% fa fa-angle-right %} How do I record my tests?
1. First {% url 'setup the project to record' dashboard-projects#Set-up-a-Project-to-Record %}.
2. Then [record your runs](#How-do-I-record-my-tests).
2. Then {% url 'record your runs' dashboard-runs %}.
After recording your tests, you will see them in the Dashboard and in the Desktop Application.
@@ -8,7 +8,7 @@ Recorded runs are the results and artifacts captured from your test runs.
**To record your tests:**
1. First {% url 'setup the project to record' dashboard-projects#Set-up-a-Project-to-Record %}.
2. Then {% url 'record your runs' dashboard-features#How-do-I-record-my-tests %}.
2. Then {% url 'record your runs' dashboard-runs %}.
# What is recorded during a test run?
+8 -1
View File
@@ -58,6 +58,8 @@
border: 0;
}
hr {
border: 0;
height: 0;
@@ -289,8 +291,13 @@
color: $color-link-hover;
border-bottom: 1px solid $color-link;
}
}
&>a {
display: inline-block;
margin-bottom: 15px;
}
strong {
font-weight: 500;
}