Develop

CONTRIBUTING.md

@@ -55,20 +55,22 @@ npm start
 Visit [http://localhost:2222/](http://localhost:2222/).
 
 **note** If you need to debug documentation build step run with environment
-variable set `DEBUG=docs npm run build` 
+variable set `DEBUG=docs npm run build`
 
 ## Writing Documentation
 
 ### Adding Examples
 
-The documents outlining examples are within the [`source/examples`](/source/examples) directory. Each document is written in markdown with a little bit of [Hexo flair](https://hexo.io/docs/tag-plugins.html). To add an example to a document, just try to follow the formatting of any previous examples in the markdown file.
+ To add an blog, talk, or podcast to our docs, just add your data to the corresponding [blogs.yml](https://github.com/cypress-io/cypress-documentation/blob/develop/source/_data/blogs.yml), [talks.yml](https://github.com/cypress-io/cypress-documentation/blob/develop/source/_data/talks.yml), or [podcasts.yml](https://github.com/cypress-io/cypress-documentation/blob/develop/source/_data/podcasts.yml) file.
 
 Add an associating image with the example within the [`source/img/examples`](/source/img/examples) directory. Each image should be resolution **715w x 480h**. Reference the image in the markdown document as follows:
 
 ```md
 {% img /img/examples/name-of-file.jpg "alt text describing img" %}
 ```
 
+To add anything else to an example page, the documents outlining examples are within the [`source/examples`](/source/examples) directory. Each document is written in markdown with a little bit of [Hexo flair](https://hexo.io/docs/tag-plugins.html). To add an example to a document, just try to follow the formatting of any previous examples in the markdown file.
+
 ## Commiting Code
 
 ### Linting

cypress/integration/api_spec.coffee

@@ -83,6 +83,19 @@ describe "API", ->
           sidebarLink  = @sidebarLinks[i]
           expect(displayedLink.attr('href')).to.include(sidebarLink)
 
+    context "mobile sidebar menu", ->
+      beforeEach ->
+        cy.viewport('iphone-6')
+
+      it "displays sidebar in mobile menu on click", ->
+        cy.get("#mobile-nav-toggle").click()
+        cy.get("#mobile-nav-inner").should("be.visible")
+          .find(".sidebar-li")
+          .first(1).each (displayedLink, i) ->
+            englishLink  = @english.sidebar.api[@sidebarLinkNames[i]]
+            expect(displayedLink.text().trim()).to.eq(englishLink)
+
+
   ## This is running too slow to include for now
   ## Issue #431 Needs to be fixed first
   ## https://github.com/cypress-io/cypress/issues/431

cypress/integration/dashboard_spec.coffee

@@ -66,3 +66,15 @@ describe "Dashboard", ->
         .find(".sidebar-link").each (displayedLink, i) ->
           sidebarLink  = @sidebarLinks[i]
           expect(displayedLink.attr('href')).to.include(sidebarLink)
+
+    context "mobile sidebar menu", ->
+      beforeEach ->
+        cy.viewport('iphone-6')
+
+      it "displays sidebar in mobile menu on click", ->
+        cy.get("#mobile-nav-toggle").click()
+        cy.get("#mobile-nav-inner").should("be.visible")
+          .find(".sidebar-li")
+          .first(1).each (displayedLink, i) ->
+            englishLink  = @english.sidebar.dashboard[@sidebarLinkNames[i]]
+            expect(displayedLink.text().trim()).to.eq(englishLink)

cypress/integration/examples_spec.coffee

@@ -66,3 +66,15 @@ describe "Examples", ->
         .find(".sidebar-link").each (displayedLink, i) ->
           sidebarLink  = @sidebarLinks[i]
           expect(displayedLink.attr('href')).to.include(sidebarLink)
+
+    context "mobile sidebar menu", ->
+      beforeEach ->
+        cy.viewport('iphone-6')
+
+      it "displays sidebar in mobile menu on click", ->
+        cy.get("#mobile-nav-toggle").click()
+        cy.get("#mobile-nav-inner").should("be.visible")
+          .find(".sidebar-li")
+          .first(1).each (displayedLink, i) ->
+            englishLink  = @english.sidebar.examples[@sidebarLinkNames[i]]
+            expect(displayedLink.text().trim()).to.eq(englishLink)

cypress/integration/faq_spec.coffee

@@ -58,6 +58,18 @@ describe "FAQ", ->
           sidebarLink  = @sidebarLinks[i]
           expect(displayedLink.attr('href')).to.include(sidebarLink)
 
+    context "mobile sidebar menu", ->
+      beforeEach ->
+        cy.viewport('iphone-6')
+
+      it "displays sidebar in mobile menu on click", ->
+        cy.get("#mobile-nav-toggle").click()
+        cy.get("#mobile-nav-inner").should("be.visible")
+          .find(".sidebar-li")
+          .first(1).each (displayedLink, i) ->
+            englishLink  = @english.sidebar.faq[@sidebarLinkNames[i]]
+            expect(displayedLink.text().trim()).to.eq(englishLink)
+
   context "Table of Contents", ->
     it "displays toc links", ->
       cy.get('.toc-level-2>.toc-link').as('tocLinks')

cypress/integration/guides_spec.coffee

@@ -71,6 +71,18 @@ describe "Guides", ->
           sidebarLink  = @sidebarLinks[i]
           expect(displayedLink.attr('href')).to.include(sidebarLink)
 
+    context "mobile sidebar menu", ->
+      beforeEach ->
+        cy.viewport('iphone-6')
+
+      it "displays sidebar in mobile menu on click", ->
+        cy.get("#mobile-nav-toggle").click()
+        cy.get("#mobile-nav-inner").should("be.visible")
+          .find(".sidebar-li")
+          .first(1).each (displayedLink, i) ->
+            englishLink  = @english.sidebar.guides[@sidebarLinkNames[i]]
+            expect(displayedLink.text().trim()).to.eq(englishLink)
+
   ## This is running too slow to include for now
   ## Issue #431 Needs to be fixed first
   ## https://github.com/cypress-io/cypress/issues/431

package.json

@@ -48,7 +48,7 @@
     "colors": "^1.1.2",
     "common-tags": "^1.4.0",
     "concurrent-transform": "^1.0.0",
-    "cypress": "^0.20.0",
+    "cypress": "^1.0.2",
     "dependency-check": "^2.9.1",
     "deps-ok": "^1.2.0",
     "eslint": "^4.6.1",