Skip to content

Commit 5d13d28

Browse files
authored
Merge pull request #1 from romi-goldz/patch-1
Update playground.mdx
2 parents e379cf7 + a5a0fc6 commit 5d13d28

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

docs/pages/learning/playground.mdx

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { Cards, Card } from "nextra-theme-docs";
1313
/>
1414
</Cards>
1515

16-
**Playground** is a tool that allows the development and QA of a module without the need for the real environment. This tool creates a _module payload_ (input config for Module) with mock data using the configuration specified in [**Setup JSON**](/learning/setup-file).
16+
**Playground** is a preview tool on a sandbox environment that enables the development and QA of a Registry airModule. This tool creates a module payload (input config for the airModule) with mock data using the configuration specified in the [**Setup JSON**](/learning/setup-file).
1717

1818
![Playground](@/assets/images/learning/playground-cover.png)
1919

@@ -26,46 +26,70 @@ The **Module Preview** shows how the module responds to the combinations that ha
2626

2727
## Tabs
2828

29-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
30-
3129
### Overview
3230

33-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
31+
The overview tab shows the details of the module displayed.
32+
33+
- **Module URL
34+
35+
- **Setup.JSON URL used for the module rendering
36+
37+
- **Viewport - adjustable settings to render the module based on changing viewports
38+
39+
- **Template - render the module in various positions within a page
40+
41+
- **Context - the context of the module currently rendered. The context can be changed, by Editing the Module Payload
3442

3543
#### Module Payload
3644

45+
The Module Payload, displays the payload used to render the module. This is the information defined within the Setup.JSON.
46+
47+
The Module Payload can be edited, to adjust the module context and details, in order to change the module rendering based on changing Module Payloads.
48+
3749
![Playground Addon Overview - Module Payload](@/assets/images/learning/playground-module-payload.png)
3850

3951
#### Template
4052

53+
Select a page template to review the module as it will appear within a web page.
54+
4155
![Playground Addon Overview - Template](@/assets/images/learning/playground-sample-page.png)
4256

4357
#### Viewport
4458

59+
Select the viewport of the module preview.
60+
4561
![Playground Addon Overview - Viewport](@/assets/images/learning/playground-mobile-viewport.png)
4662

4763
### Settings
4864

49-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
65+
The Settings tab allows configuring the module, using the available configuration available for the modules. For example, if a module allows adjusting the filters within the module, those settings can be set within the Settings tab, to test the module based on changing configurations.
5066

5167
![Playground Addon Settings](@/assets/images/learning/playground-addon-settings.png)
5268

5369
### Styles
5470

55-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
56-
57-
![Playground Addon Styles - High Contrast](@/assets/images/learning/playground-addon-styles-high-contrast.png)
71+
The Styles tab, allows updating the style of the module to preview any desired change to the module styling. The user can manually set the objects styling or select between a few generic themes.
5872

5973
![Playground Addon Styles - Dark](@/assets/images/learning/playground-addon-styles-dark.png)
6074

6175
### I18N
6276

63-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
77+
In the I18n tab, the module labels can be set to update and preview the module components verbiage and language.
6478

6579
![Playground Addon I18N](@/assets/images/learning/playground-addon-i18n.png)
6680

81+
### Test
82+
83+
The Test Tab can be used to render the module just as it will appear on a live airTRFX page.
84+
85+
This includes any page of a valid tenant, site edition, page slug, and defined theme.
86+
87+
The user can either manually enter test scenarios, or upload a JSON file, to populate pre-set scenarios.
88+
89+
*The test scenarios parameters are case sensitive*
90+
6791
### Logs
6892

69-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
93+
This tab can be used to troubleshoot and get visibility over the API calls used to load data.
7094

7195
![Playground Addon Logs](@/assets/images/learning/playground-addon-logs.png)

0 commit comments

Comments
 (0)