This repository has been archived by the owner on Apr 18, 2022. It is now read-only.
[MAINTENANCE] Add links to correct API type documentation in book #1332
Labels
diff: normal
Achievable by an reasonable experienced developer. If new to Amethyst, may need some guidance.
pri: normal
An issue that is causing a noticeable impact, but can be worked around
stale
Issue had no recent activity
team: documentation
type: maintenance
A task that has no noticeable user-facing effect. Code cleanup, small refactors, etc.
Description
At the moment afaict there are a total of two API documentation links in the book, one for Animation "Definition" which links to the docs.rs documentation, and another on the Introduction page which always links to the
master
branch docs, even if you're on the "Latest Release" book. None of the type names in the book have API links.Reason
Users expect once they've navigated to either the "latest" or "master" areas to be kept there, but there's currently no mechanism for this.
Impact
Might be a large PR depending on execution.
Additional Information
There are a few ways in which this can be remedied.
The text was updated successfully, but these errors were encountered: