docs(all): improve readme structure and examples (#227)

clebert · Apr 24, 2018 · 99aa824 · 99aa824
1 parent 707b7b5
commit 99aa824
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 40 deletions.
diff --git a/@pageobject/todomvc/README.md b/@pageobject/todomvc/README.md
@@ -26,7 +26,7 @@ You can find the **complete code** of all test cases [here](https://github.com/c
 ### Creating todos
 
 ```js
-test.perform(app.page.goto('http://todomvc.com/examples/react/#/'), 30);
+test.perform(app.page.goto('http://todomvc.com/examples/react/#/'));
 
 test
   .assert(app.newTodoInput.hasFocus(), is(true), 'newTodoInput has focus (1)')
@@ -46,7 +46,7 @@ test
 ### Completing a todo
 
 ```js
-test.perform(app.page.goto('http://todomvc.com/examples/react/#/'), 30);
+test.perform(app.page.goto('http://todomvc.com/examples/react/#/'));
 
 test
   .assert(app.newTodoInput.hasFocus(), is(true), 'newTodoInput has focus')

diff --git a/@pageobject/todomvc/src/tests/completing-a-todo.test.ts b/@pageobject/todomvc/src/tests/completing-a-todo.test.ts
@@ -4,7 +4,7 @@ import {jestTest} from './jestTest';
 const {is} = Predicate;
 
 jestTest('Completing a todo', (test, app) => {
-  test.perform(app.page.goto('http://todomvc.com/examples/react/#/'), 30);
+  test.perform(app.page.goto('http://todomvc.com/examples/react/#/'));
 
   test
     .assert(app.newTodoInput.hasFocus(), is(true), 'newTodoInput has focus')

diff --git a/@pageobject/todomvc/src/tests/creating-todos.test.ts b/@pageobject/todomvc/src/tests/creating-todos.test.ts
@@ -4,7 +4,7 @@ import {jestTest} from './jestTest';
 const {is} = Predicate;
 
 jestTest('Creating todos', (test, app) => {
-  test.perform(app.page.goto('http://todomvc.com/examples/react/#/'), 30);
+  test.perform(app.page.goto('http://todomvc.com/examples/react/#/'));
 
   test
     .assert(app.newTodoInput.hasFocus(), is(true), 'newTodoInput has focus (1)')

diff --git a/README.md b/README.md
@@ -103,37 +103,31 @@ function example(test, app) {
 }
 ```
 
-**For further examples, please consult the list of [example projects](#example-projects).**
+## Further examples
 
-## API documentation
+### [@pageobject/todomvc][internal-api-todomvc]
 
-### Foundation
+An exemplary test suite for the popular TodoMVC application.
+
+## Packages
 
-#### [@pageobject/base][internal-api-base]
+### [@pageobject/base][internal-api-base]
 
 A declarative API as a **basis** for platform- and framework-independent UI test automation.
 
-#### [@pageobject/web][internal-api-web]
+### [@pageobject/web][internal-api-web]
 
 A declarative API for framework-independent **web** UI test automation.
 
-### Example projects
-
-#### [@pageobject/todomvc][internal-api-todomvc]
-
-An exemplary test suite for the popular TodoMVC application.
-
-### Adapter implementations
-
-#### [@pageobject/protractor][internal-api-protractor]
+### [@pageobject/protractor][internal-api-protractor]
 
 A web API adapter for Protractor.
 
-#### [@pageobject/puppeteer][internal-api-puppeteer]
+### [@pageobject/puppeteer][internal-api-puppeteer]
 
 A web API adapter for Puppeteer.
 
-#### [@pageobject/selenium-webdriver][internal-api-selenium-webdriver]
+### [@pageobject/selenium-webdriver][internal-api-selenium-webdriver]
 
 A web API adapter for Selenium.
 

diff --git a/docs/api/todomvc/globals.html b/docs/api/todomvc/globals.html
@@ -947,7 +947,7 @@ <h2 id="introduction">Introduction</h2>
 			<h2 id="test-cases">Test cases</h2>
 			<p>You can find the <strong>complete code</strong> of all test cases <a href="https://github.com/clebert/pageobject/blob/master/@pageobject/todomvc/src/tests/">here</a>.</p>
 			<h3 id="creating-todos">Creating todos</h3>
-			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>), <span class="hljs-number">30</span>);
+			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>));
 
 test
   .assert(app.newTodoInput.hasFocus(), is(<span class="hljs-literal">true</span>), <span class="hljs-string">'newTodoInput has focus (1)'</span>)
@@ -963,7 +963,7 @@ <h3 id="creating-todos">Creating todos</h3>
 </code></pre>
 			<p><img src="../../images/creating-todos.png" alt="Creating todos"></p>
 			<h3 id="completing-a-todo">Completing a todo</h3>
-			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>), <span class="hljs-number">30</span>);
+			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>));
 
 test
   .assert(app.newTodoInput.hasFocus(), is(<span class="hljs-literal">true</span>), <span class="hljs-string">'newTodoInput has focus'</span>)

diff --git a/docs/api/todomvc/index.html b/docs/api/todomvc/index.html
@@ -947,7 +947,7 @@ <h2 id="introduction">Introduction</h2>
 			<h2 id="test-cases">Test cases</h2>
 			<p>You can find the <strong>complete code</strong> of all test cases <a href="https://github.com/clebert/pageobject/blob/master/@pageobject/todomvc/src/tests/">here</a>.</p>
 			<h3 id="creating-todos">Creating todos</h3>
-			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>), <span class="hljs-number">30</span>);
+			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>));
 
 test
   .assert(app.newTodoInput.hasFocus(), is(<span class="hljs-literal">true</span>), <span class="hljs-string">'newTodoInput has focus (1)'</span>)
@@ -963,7 +963,7 @@ <h3 id="creating-todos">Creating todos</h3>
 </code></pre>
 			<p><img src="../../images/creating-todos.png" alt="Creating todos"></p>
 			<h3 id="completing-a-todo">Completing a todo</h3>
-			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>), <span class="hljs-number">30</span>);
+			<pre><code class="lang-js">test.perform(app.page.goto(<span class="hljs-string">'http://todomvc.com/examples/react/#/'</span>));
 
 test
   .assert(app.newTodoInput.hasFocus(), is(<span class="hljs-literal">true</span>), <span class="hljs-string">'newTodoInput has focus'</span>)

diff --git a/docs/index.md b/docs/index.md
@@ -103,37 +103,31 @@ function example(test, app) {
 }
 ```
 
-**For further examples, please consult the list of [example projects](#example-projects).**
+## Further examples
 
-## API documentation
+### [@pageobject/todomvc][internal-api-todomvc]
 
-### Foundation
+An exemplary test suite for the popular TodoMVC application.
+
+## Packages
 
-#### [@pageobject/base][internal-api-base]
+### [@pageobject/base][internal-api-base]
 
 A declarative API as a **basis** for platform- and framework-independent UI test automation.
 
-#### [@pageobject/web][internal-api-web]
+### [@pageobject/web][internal-api-web]
 
 A declarative API for framework-independent **web** UI test automation.
 
-### Example projects
-
-#### [@pageobject/todomvc][internal-api-todomvc]
-
-An exemplary test suite for the popular TodoMVC application.
-
-### Adapter implementations
-
-#### [@pageobject/protractor][internal-api-protractor]
+### [@pageobject/protractor][internal-api-protractor]
 
 A web API adapter for Protractor.
 
-#### [@pageobject/puppeteer][internal-api-puppeteer]
+### [@pageobject/puppeteer][internal-api-puppeteer]
 
 A web API adapter for Puppeteer.
 
-#### [@pageobject/selenium-webdriver][internal-api-selenium-webdriver]
+### [@pageobject/selenium-webdriver][internal-api-selenium-webdriver]
 
 A web API adapter for Selenium.