Skip to content

Commit

Permalink
Start reorganizing docs mdx components into subfolders
Browse files Browse the repository at this point in the history
  • Loading branch information
flaurida committed Mar 9, 2020
1 parent bb400ef commit 9611173
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 55 deletions.
4 changes: 2 additions & 2 deletions docs/docs/api/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ id: cli
title: CLI
---

import ArgumentCreate from './components/ArgumentCreate';
import ArgumentTest from './components/ArgumentTest';
import ArgumentCreate from './components/cli/ArgumentCreate';
import ArgumentTest from './components/cli/ArgumentTest';

This guide lists the QA Wolf commands you can run in the [CLI](../install#understand-the-command-line).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import Argument from './Argument';
import Argument from '../Argument';

function ArgumentCreate() {
return (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import React from 'react';
import Link from '@docusaurus/Link';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Argument from './Argument';
import ArgumentAllBrowsers from './ArgumentAllBrowsers';
import ArgumentFirefox from './ArgumentFirefox';
import ArgumentWebKit from './ArgumentWebKit';
import Argument from '../Argument';
import ArgumentAllBrowsers from '../ArgumentAllBrowsers';
import ArgumentFirefox from '../ArgumentFirefox';
import ArgumentWebKit from '../ArgumentWebKit';

function ArgumentTest() {
return (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import Argument from './Argument';
import Argument from '../Argument';

function ArgumentLaunch() {
return (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import Link from '@docusaurus/Link';
import useBaseUrl from '@docusaurus/useBaseUrl';
import React from 'react';
import Argument from './Argument';
import Argument from '../Argument';

function ReturnBrowser() {
return (
Expand Down
15 changes: 15 additions & 0 deletions docs/docs/api/qawolf/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: create
sidebar_label: create
title: qawolf.create
---

import Syntax from '../components/Syntax';

<Syntax code="create([options={}])" />

### Arguments

### Returns

### Examples
4 changes: 2 additions & 2 deletions docs/docs/api/qawolf/launch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ sidebar_label: launch
title: qawolf.launch
---

import ArgumentLaunch from '../components/ArgumentLaunch';
import ReturnBrowser from '../components/ReturnBrowser';
import ArgumentLaunch from '../components/qawolf/ArgumentLaunch';
import ReturnBrowser from '../components/qawolf/ReturnBrowser';
import Syntax from '../components/Syntax';

<Syntax code="launch([options={}])" />
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/api/table_of_contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ In addition to the APIs below, you have full access to the [Playwright API](http

## module: qawolf

[create](qawolf/create)

[launch](qawolf/launch)

[repl](qawolf/repl)
Expand Down
84 changes: 42 additions & 42 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
@@ -1,62 +1,62 @@
module.exports = {
get_started: [
{ type: "doc", id: "what_is_qa_wolf" },
{ type: 'doc', id: 'what_is_qa_wolf' },
{
type: "doc",
id: "install"
type: 'doc',
id: 'install',
},
{
type: "doc",
id: "create_a_test"
type: 'doc',
id: 'create_a_test',
},
{
type: "doc",
id: "run_tests_locally"
type: 'doc',
id: 'run_tests_locally',
},
{ type: "doc", id: "run_tests_in_ci" }
{ type: 'doc', id: 'run_tests_in_ci' },
],
guides: [
{ type: "doc", id: "use_the_repl" },
{ type: "doc", id: "add_assertions" },
{ type: "doc", id: "use_custom_selectors" },
{ type: "doc", id: "change_input_values" },
{ type: "doc", id: "emulate_a_device" },
{ type: "doc", id: "use_typescript" },
{ type: "doc", id: "create_a_script" },
{ type: 'doc', id: 'use_the_repl' },
{ type: 'doc', id: 'add_assertions' },
{ type: 'doc', id: 'use_custom_selectors' },
{ type: 'doc', id: 'change_input_values' },
{ type: 'doc', id: 'emulate_a_device' },
{ type: 'doc', id: 'use_typescript' },
{ type: 'doc', id: 'create_a_script' },
{
type: "category",
label: "Advanced",
items: ["how_it_works", "contribute"]
}
type: 'category',
label: 'Advanced',
items: ['how_it_works', 'contribute'],
},
],
api: [
{ type: "doc", id: "api/table_of_contents" },
{ type: "doc", id: "api/cli" },
{ type: 'doc', id: 'api/table_of_contents' },
{ type: 'doc', id: 'api/cli' },
{
type: "doc",
id: "api/environment_variables"
type: 'doc',
id: 'api/environment_variables',
},
{
type: "category",
label: "module: qawolf",
items: ["api/qawolf/launch", "api/qawolf/repl"]
type: 'category',
label: 'module: qawolf',
items: ['api/qawolf/create', 'api/qawolf/launch', 'api/qawolf/repl'],
},
{
type: "category",
label: "class: BrowserContext",
type: 'category',
label: 'class: BrowserContext',
items: [
"api/browser_context/class_browser_context",
"api/browser_context/click",
"api/browser_context/close",
"api/browser_context/find",
"api/browser_context/find_property",
"api/browser_context/goto",
"api/browser_context/has_text",
"api/browser_context/page",
"api/browser_context/scroll",
"api/browser_context/select",
"api/browser_context/type"
]
}
]
'api/browser_context/class_browser_context',
'api/browser_context/click',
'api/browser_context/close',
'api/browser_context/find',
'api/browser_context/find_property',
'api/browser_context/goto',
'api/browser_context/has_text',
'api/browser_context/page',
'api/browser_context/scroll',
'api/browser_context/select',
'api/browser_context/type',
],
},
],
};

0 comments on commit 9611173

Please sign in to comment.