Skip to content

Commit 7061048

Browse files
xcao65GitHub Enterprise
authored andcommitted
fix markdown docs linking issue (#40)
1 parent 734c9a3 commit 7061048

File tree

5 files changed

+7
-6
lines changed

5 files changed

+7
-6
lines changed

.github/workflows/pre-commit.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ jobs:
4848
with:
4949
node-version: '12'
5050
- name: Install manual dependencies
51+
# pin markdown-link-check version to support multi-level reference link
5152
run: |
52-
sudo npm install -g markdown-link-check
53+
sudo npm install -g markdown-link-check@3.8.7
5354
python -m pip install pre-commit
5455
pre-commit install
5556
- name: Run markdown checker

docs/Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ You will need to clone the repository if you plan to modify or extend the
7474
ML-Agents Toolkit for your purposes. If you plan to contribute those changes
7575
back, make sure to clone the `main` branch (by omitting `--branch release_19`
7676
from the command above). See our
77-
[Contributions Guidelines](../com.unity.ml-agents/CONTRIBUTING.md) for more
77+
[Contributions Guidelines](CONTRIBUTING.md) for more
7878
information on contributing to the ML-Agents Toolkit.
7979

8080
### Install the `com.unity.ml-agents` Unity package

docs/Learning-Environment-Examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This page only overviews the example environments we provide. To learn more on
1818
how to design and build your own environments see our
1919
[Making a New Learning Environment](Learning-Environment-Create-New.md) page. If
2020
you would like to contribute environments, please see our
21-
[contribution guidelines](../com.unity.ml-agents/CONTRIBUTING.md) page.
21+
[contribution guidelines](CONTRIBUTING.md) page.
2222

2323
## Basic
2424

docs/Limitations.md

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

33
See the package-specific Limitations pages:
44

5-
- [`com.unity.mlagents` Unity package](com.unity.ml-agents.md)
5+
- [`com.unity.mlagents` Unity package](https://docs.unity3d.com/Packages/com.unity.ml-agents@2.1/manual/index.html#known-limitations)
66
- [`mlagents` Python package](ML-Agents-README.md)
7-
- [`mlagents_envs` Python package](ML-Agents-Envs-README.md)
7+
- [`mlagents_envs` Python package](../ml-agents-envs/README.md#limitations)

docs/Training-ML-Agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ Below is a list of the `sampler_type` values supported by the toolkit.
509509
- **parameters** - `intervals`
510510

511511
The implementation of the samplers can be found in the
512-
[Samplers.cs file](../com.unity.ml-agents/Runtime/Sampler.cs).
512+
[Samplers.cs file](https://github.com/Unity-Technologies/ml-agents/blob/main/com.unity.ml-agents/Runtime/Sampler.cs).
513513

514514
##### Training with Environment Parameter Randomization
515515

0 commit comments

Comments
 (0)