Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add about and configuration documentation #60

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Add about and configuration documentation #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
378b1ef
Create a Configuration Reference doc template
cloudjumpercat Jun 1, 2023
add92be
Create About page template for the example application
cloudjumpercat Jun 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# About the Example Konnect Portal Application

This page explains how the example Konnect portal application works, how you can customize it, and how to configure UI testing with Cypress.

## How the example application works

<!-- depending on how much info you have, this could be one or multiple sections with some tech details users would need to know before using
this app -->

## Customize the example Konnect portal application

<!-- This would probably be a numbered list with some directions on how users can customize the settings -->

For more information about what parameters you can configure, see [Configuration Reference](/docs/reference.md).

## Configure automated UI testing with Cypress

<!-- I wasn't sure if this was something users would have to configure at all, but I do think they should have some info about how this works.
Feel free to remove or rename this section -->
10 changes: 10 additions & 0 deletions docs/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Configuration Reference

This page explains the different parameters you can configure and what they do.

| Parameter | Notes |
| --------- | ---------- |
|Example | Example |
|Example | Example |

<!-- Maybe have different h2 sections with separate tables if there's a lot of different parameters? Like ones for localization, others for UI customization, etc. -->