Skip to content

docs: replace broken environment links with @ref cross-references#1095

Open
ram-cs7 wants to merge 1 commit intoJuliaReinforcementLearning:mainfrom
ram-cs7:fix/broken-doc-references-links
Open

docs: replace broken environment links with @ref cross-references#1095
ram-cs7 wants to merge 1 commit intoJuliaReinforcementLearning:mainfrom
ram-cs7:fix/broken-doc-references-links

Conversation

@ram-cs7
Copy link
Copy Markdown

@ram-cs7 ram-cs7 commented Mar 17, 2026

Fixes part of #1060

All 13 environment links in the Built-in Environments table in docs/src/rlenvs.md pointed to juliareinforcementlearning.org/docs/rlenvs/which returns 404, causing doc build failures.

Replaced broken HTML anchor links with plain text environment names since the environment structs do not currently have docstrings for @ref resolution. This removes 13 linkcheck errors from the doc build.

All 13 environment links in rlenvs.md pointed to
juliareinforcementlearning.org/docs/rlenvs/ which returns 404.
Replaced with proper Documenter @ref cross-references.

Fixes part of JuliaReinforcementLearning#1060

Signed-off-by: Sairam Chennaka <sairam.chennaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant