Skip to content

Commit e13fc07

Browse files
authored
[docs] chore(workflows): Check MkDocs URIs
1 parent 8453c82 commit e13fc07

18 files changed

Lines changed: 64 additions & 19 deletions
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Check MkDocs URIs
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
check-mkdocs-uris:
11+
name: Validate MkDocs URIs
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
18+
- name: Install dependencies
19+
run: |
20+
python -m pip install --upgrade pip
21+
pip install -r requirements.txt
22+
23+
- name: Disable git-committers plugin in CI
24+
# The git-committers plugin is not CI-safe:
25+
# it performs GitHub API calls even without an explicit token,
26+
# which causes 403 rate-limit errors in GitHub Actions.
27+
# We remove the plugin block entirely for CI builds.
28+
run: |
29+
sed -i '/- git-committers:/,/^[[:space:]]*-[[:space:]]/d' mkdocs.yml
30+
31+
- name: Check for underscores in MkDocs URIs
32+
run: |
33+
echo "Checking mkdocs.yml for URIs (use '-' instead of '_')"
34+
35+
INVALID_PATHS=$(grep '.md' mkdocs.yml | grep '_' | grep -Ev 'pymdownx\.superfences|md_in_html' || true)
36+
37+
if [ -n "$INVALID_PATHS" ]; then
38+
echo "❌ Invalid MkDocs URIs detected (use '-' instead of '_'):"
39+
echo "$INVALID_PATHS" | sed 's/^/ - /'
40+
echo "Required format:"
41+
echo "usage/scenarios_and_simulations.md -> usage/scenarios-and-simulations.md"
42+
exit 1
43+
else
44+
echo "✅ All MkDocs URIs are clean (no underscores)."
45+
fi

docs/deployment/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ docker compose up -d
8888

8989
This section provides instructions to install and run a pre-built OpenAEV server with its dependencies. Note that this
9090
does not cover building from source,
91-
which you will find in the [Development section](../development/build_from_source.md) instead.
91+
which you will find in the [Development section](../development/build-from-source.md) instead.
9292

9393
### Prepare the installation
9494

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Ensure you have followed the steps for installing prerequisites according to your development
44
platform of choice:
55

6-
* [Linux (Ubuntu used as example)](environment_ubuntu.md)
7-
* [Windows](environment_windows.md)
6+
* [Linux (Ubuntu used as example)](environment-ubuntu.md)
7+
* [Windows](environment-windows.md)
88
* MacOS (TBD)
99

1010
# Building and running from source

docs/usage/components/channels.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Channels
22

3-
In OpenAEV, Channels represent communication medias with a particular look. They are used to present [web articles or other media contents](media_pressure.md) to Players in a specific way.
3+
In OpenAEV, Channels represent communication medias with a particular look. They are used to present [web articles or other media contents](media-pressure.md) to Players in a specific way.
44

55
It helps give shape to your Scenario context and events.
66

@@ -20,6 +20,6 @@ On the right, a mock up of the overview is displayed to give you the look and fi
2020

2121
A Channel will then be used in Scenario and in Simulation definition. When you create an Article, you have to choose the Channel that will give it an adequate shape.
2222

23-
See [Media pressure](media_pressure.md) page to know how to create and add Articles to your Scenarios.
23+
See [Media pressure](media-pressure.md) page to know how to create and add Articles to your Scenarios.
2424

2525
![Channel selection during Article creation](../assets/channel_selection_during_creation.png)
File renamed without changes.

docs/usage/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ You can:
6767
Once defined, a scenario can be turned into a [simulation](simulation.md): a live execution in your environment, either
6868
one-shot or scheduled regularly.
6969

70-
During simulations, [expectations](injects_and_expectations.md) are validated:
70+
During simulations, [expectations](injects-and-expectations.md) are validated:
7171

7272
- **Automatically**, via integrations with your stack
7373
- **Manually**, by observers validating human reactions

0 commit comments

Comments
 (0)