Doc/Fix images and links - #36
Merged
Merged
Conversation
Every documentation link in the README is repo-relative, so it renders the raw Markdown on GitHub and never reaches the site at yannberthelot.github.io/TargetGym. Nothing anywhere pointed at it. The relative links stay, since a build hook rewrites them and they are the right links for someone reading on GitHub. What was missing is an entry point: a docs badge, placed first so it reads before the version and licence metadata, and a line in the Documentation section naming the site and explaining that the links above are Markdown paths rewritten at build time. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012WdRJEyGAZwKDD1EFwwH3U
[project.urls] declared only Homepage and Repository, both the repository root, so anyone arriving from `pip install target-gym` had to find the docs themselves. PyPI renders these as a labelled sidebar and recognises "Documentation", "Issues" and "Changelog" as named keys with their own icons. Verified against a built wheel: all five appear in the metadata. This takes effect on the next release; 0.6.0 on PyPI keeps the two it was published with. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012WdRJEyGAZwKDD1EFwwH3U
The live site's homepage contradicted itself in adjacent lines: "Twenty-two JAX
environments" above "**21 environments**". It also carried the gallery caption
that was corrected in the README ("held on setpoint by its shipped PID
baseline", which implies a PID is all that ships) and opened its quickstart with
`REGISTRY["plane"].make_pid()`, the registry detour removed from the README for
not resembling how any other environment library is used.
All three now match: 21 environments, "One example task from each family, under
PID control", and `Plane()` with `env.make_pid()` and `reset`/`step` falling
back to default parameters.
The CHANGELOG claimed twenty-two in two more places.
Nothing outside the roadmap's own history now says twenty-two.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012WdRJEyGAZwKDD1EFwwH3U
Every environment page on the published site showed a broken image. The generator emitted `../videos/<env>/pid_output.gif`, and mkdocs serves these with directory URLs, so the page is `/environments/<name>/` and a relative source resolves against that directory. The browser asked for `/environments/videos/<env>/pid_output.gif` and got a 404. The homepage was fine because it sits at the site root, which is why this looked like it worked. mkdocs rewrites relative links in Markdown but not inside raw HTML, and these are `<p align="center"><img ...>` for centring, so the depth has to be right in the generator. Verified by serving the built site, taking the src as the page writes it, resolving it against the page's own URL and fetching it: 200 on ten sampled environments. The earlier check tested that the *files* existed at `/videos/...`, which they always did, rather than that the *links* reached them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012WdRJEyGAZwKDD1EFwwH3U
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.