Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Empty file added .eslintrc
Empty file.
17 changes: 16 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,34 @@ concurrency:
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci

- name: Format
run: npm run format:check

- name: Lint
run: npm run lint

- name: Build
run: npm run build

- name: Setup Pages
uses: actions/configure-pages@v5
if: github.ref == 'refs/heads/main' && github.event_name == 'push'

- name: Upload artifact
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
uses: actions/upload-pages-artifact@v3
Expand All @@ -43,9 +56,11 @@ jobs:
needs: build
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
runs-on: ubuntu-latest

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4
5 changes: 5 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Ignore artifacts
build

# Ignore mdx as only legacy mdx is supported by prettier
*.mdx
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"semi": false,
"endOfLine": "lf"
}
2 changes: 1 addition & 1 deletion docs/errors/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# What to Do If Something Goes Wrong

## Reset the Stage
## Reset the Stage {/* #reset-the-stage */}

If you encounter any issues while uploading start times or results
(e.g., uploading data to the wrong stage), you can reset the stage.
Expand Down
4 changes: 2 additions & 2 deletions docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1

Let's discover **O-Replay in less than 5 minutes**.

## Structure
## Structure {/* #structure */}

Races in O-Replay are organized into events and stages.

Expand All @@ -18,7 +18,7 @@ Each stage can represent a different orienteering discipline.

For a single race, you would create an event "Long Distance" with a single stage "Long Distance".

## Workflow Summary
## Workflow Summary {/* #workflow-summary */}

There are two main components in O-Replay:
1. **O-Replay WEB**: *Manage your events*
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/pc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2

# Manage O-Replay Desktop Client

## Installing the Desktop Client in your PC
## Installing the Desktop Client in your PC {/* #installing-the-desktop-client-in-your-pc */}

Results are uploaded using a small program that must be installed on your computer.
We provide an installer that works on Windows 11.
Expand All @@ -20,7 +20,7 @@ If you are using other operating systems, such as Linux or macOS,
or if your Windows 10 installation fails,
you can still use the client via [manual installation](https://github.com/oreplay/desktop-client/releases/).

## Managing the Client
## Managing the Client {/* #managing-the-client */}

Follow the next steps to upload files:

Expand Down
4 changes: 2 additions & 2 deletions docs/setup/web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ sidebar_position: 1

# Manage O-Replay WEB

## Register to O-Replay
## Register to O-Replay {/* #register-to-o-replay */}

Navigate to our [sign-up page](http://www.oreplay.es/sign-up) to create an account.

Please note that O-Replay is in active development.
Many planned features are not yet available, but the system is ready for its use.

## Create an Event
## Create an Event {/* #create-an-event */}

Races in O-Replay are organized into events and stages.
For example, if you are running a weekend championship with middle and long-distance races,
Expand Down
12 changes: 6 additions & 6 deletions docs/uploads/classic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import TabItem from '@theme/TabItem';

# Classic Stages

## Before the Race
## Before the Race {/* #before-the-race */}

### Uploading Start Times
### Uploading Start Times {/* #uploading-start-times */}

Start times are uploaded for two purposes:
1. To display them for runners' information.
Expand Down Expand Up @@ -77,9 +77,9 @@ If you want to upload start times after uploading results you need to Reset the
:::


## During the Race
## During the Race {/* #during-the-race */}

### Uploading Results
### Uploading Results {/* #uploading-results */}

We support IOF XML v3 splits files for uploading results.
Use an empty folder to save these files (you can reuse the folder created for start times).
Expand Down Expand Up @@ -172,7 +172,7 @@ Some classes may already have been saved to the server, so the process will even
Check out the [Overall Results](./overall.mdx) page for multi-stage competitions.
:::

### Upload Online Controls
### Upload Online Controls {/* #upload-online-controls */}

If you are using online controls in your race, in addition to the previous steps,
you must export and upload those online splits.
Expand Down Expand Up @@ -226,7 +226,7 @@ We support IOF XML v3. You can export the files to the same folder you are expor
</TabItem>
</Tabs>

## Other considerations
## Other considerations {/* #other-considerations */}

:::tip
Check out the [Overall Results](./overall.mdx) page for multi-stage competitions.
Expand Down
2 changes: 1 addition & 1 deletion docs/uploads/overall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';

# Overall Results

## Uploading Multi-Stage Overall Results
## Uploading Multi-Stage Overall Results {/* #uploading-multi-stage-overall-results */}

It is common for multi-stage competitions to award prizes based on the results of all races.
In such cases, the overall result of a runner is calculated either as the sum of
Expand Down
3 changes: 0 additions & 3 deletions docs/uploads/raid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
sidebar_position: 4
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Raids / Adventure Races

:::danger[Not supported yet]
Expand Down
9 changes: 3 additions & 6 deletions docs/uploads/relay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
sidebar_position: 3
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Relay Stages

:::danger[Not supported yet]
Expand All @@ -17,9 +14,9 @@ given by a comment by pimatherror on Apr 6 in the GitHub Issue:
[Relays support #58](https://github.com/oreplay/oreplay-backend/issues/58#issuecomment-4193435930).
:::

## Test results with OS12
## Test results with OS12 {/* #test-results-with-os12 */}
Tested uploading 2 xml file types and getting full data for relay competitions (splits included, but not online/radio controls).
### Official Results (by class):
### Official Results (by class): {/* #official-results-by-class */}
Final results for teams with final result: either complete team has finished or a member is not qualified (MP/DISQ/DNF/DNS...).

This file can include splits with the "extended format" configuration:
Expand All @@ -31,7 +28,7 @@ This file can include splits with the "extended format" configuration:

O-Replay Desktop and Backend already processes the split times and final positions (from this XML file) correctly.

### Provisional Results (by class):
### Provisional Results (by class): {/* #provisional-results-by-class */}
For live coverage of the event, we want info about results of current legs.
This XML file does NOT include split times, so Official Results are still necessary.
**Note that** there is no need to upload split times from the "Results -> Splits -> by class" window/report (which only allows a CSV export, no XML). Hence, there is is no need to have 2 client instances reading CSV and XML respectively
Expand Down
11 changes: 4 additions & 7 deletions docs/uploads/score.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
sidebar_position: 2
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Score Stages

:::danger[Soon]
Expand All @@ -18,11 +15,11 @@ some CSV formats are also accepted (OEScore2010 / OEScore12).
More details soon.
:::

## Before the Race
## Before the Race {/* #before-the-race */}

### Uploading Entries / Start Times
### Uploading Entries / Start Times {/* #uploading-entries--start-times */}

## During the Race
## During the Race {/* #during-the-race */}

### Uploading Results
### Uploading Results {/* #uploading-results */}

Loading
Loading