Skip to content
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

Closed
distransient opened this issue Jan 8, 2019 · 1 comment
Closed
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.

Comments

@distransient
Copy link
Member

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.

  1. Javascript added to mdbook output that adds/rewrites correct type api doc links to type names (unfavorable)
  2. Implement a custom mdbook compilation step with our own preprocessor that adds/rewrites correct type api doc links to type names
  3. Wait for/implement rust-lang-nursery/mdBook#760 and use an environment variable during compilation to hand in a url prefix for docs
@distransient distransient added type: maintenance A task that has no noticeable user-facing effect. Code cleanup, small refactors, etc. status: needs triage 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 team: documentation and removed status: needs triage labels Jan 8, 2019
@stale
Copy link

stale bot commented May 24, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Feel free to comment if this ticket is still relevant.

@stale stale bot added the stale Issue had no recent activity label May 24, 2019
@stale stale bot closed this as completed May 31, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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.
Projects
None yet
Development

No branches or pull requests

1 participant