Skip to content

fix(stable-baselines3): repair broken API reference links - #233

Merged
TKassis merged 1 commit into
K-Dense-AI:mainfrom
BriceZemba:fix/stable-baselines3-broken-doc-links
Aug 29, 2026
Merged

fix(stable-baselines3): repair broken API reference links#233
TKassis merged 1 commit into
K-Dense-AI:mainfrom
BriceZemba:fix/stable-baselines3-broken-doc-links

Conversation

@BriceZemba

Copy link
Copy Markdown
Contributor

Two "API Reference" links in the stable-baselines3 skill return 404.

Broken

  • skills/stable-baselines3/references/callbacks.md:570
    https://stable-baselines3.readthedocs.io/en/master/common/callbacks.html — 404
  • skills/stable-baselines3/references/vectorized_envs.md:579
    https://stable-baselines3.readthedocs.io/en/master/common/vec_env.html — 404

Cause

Upstream Stable-Baselines3 documents stable_baselines3.common.callbacks and
stable_baselines3.common.vec_env on the same pages as their narrative guides.
There is no common/ path for either module.

The "Official ... Guide" bullet directly above each broken link already used the
correct guide/ path, so the two common/ URLs were inconsistent within their
own files.

Fix

Repointed both at the module anchors on the guide pages, which keeps the
"Guide" and "API Reference" bullets pointing at distinct targets:

  • guide/callbacks.html#module-stable_baselines3.common.callbacks
  • guide/vec_envs.html#module-stable_baselines3.common.vec_env

Verification

  • Both replacement URLs return HTTP 200.
  • Both anchor ids (id="module-stable_baselines3.common.callbacks",
    id="module-stable_baselines3.common.vec_env") confirmed present in the
    rendered HTML.
  • Cross-checked against the upstream genindex.html, which resolves every
    stable_baselines3.common.callbacks.* and stable_baselines3.common.vec_env.*
    entry to these guide pages — confirming no common/ page exists.
  • uv run skills-ref validate ./skills/stable-baselines3 passes.
  • uv run --with pytest python -m pytest tests/_meta -q shows no new failures
    against a pre-change baseline.

Notes

  • Bumped metadata.version from "1.1" to "1.2" per CONTRIBUTING.
  • Documentation-only change; no scripts/ touched, so no security scan was run.

The "API Reference" bullets in references/callbacks.md and
references/vectorized_envs.md pointed at
`/en/master/common/callbacks.html` and `/en/master/common/vec_env.html`,
which both return 404. Upstream Stable-Baselines3 documents the
`stable_baselines3.common.callbacks` and `stable_baselines3.common.vec_env`
modules on the same pages as their narrative guides, not under `common/`.

Repoint both links at the module anchors on the guide pages:

- guide/callbacks.html#module-stable_baselines3.common.callbacks
- guide/vec_envs.html#module-stable_baselines3.common.vec_env

Both targets and both anchors were verified against the live docs and the
upstream genindex. The "Official ... Guide" bullet directly above each one
already used the correct `guide/` path, so the two `common/` URLs were
inconsistent within their own files.

Bump metadata.version to "1.2".

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 28, 2026 10:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Repairs broken Stable-Baselines3 documentation links inside the stable-baselines3 skill by updating two “API Reference” URLs that were pointing to non-existent upstream common/ pages, and bumps the skill metadata version to reflect the documentation change.

Changes:

  • Updated “Callback API Reference” link to the correct guide/callbacks.html#module-... anchor.
  • Updated “VecEnv API Reference” link to the correct guide/vec_envs.html#module-... anchor.
  • Bumped skills/stable-baselines3 skill metadata.version from "1.1" to "1.2".

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
skills/stable-baselines3/SKILL.md Bumps metadata.version to reflect the doc fix.
skills/stable-baselines3/references/vectorized_envs.md Fixes the VecEnv API reference URL to a working upstream module anchor.
skills/stable-baselines3/references/callbacks.md Fixes the callbacks API reference URL to a working upstream module anchor.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@TKassis
TKassis merged commit 72d742e into K-Dense-AI:main Aug 29, 2026
@BriceZemba
BriceZemba deleted the fix/stable-baselines3-broken-doc-links branch August 29, 2026 14:22
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.

3 participants