Add an icon to indicate links in ToC that link to other pages #189
Conversation
This file contains 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
jsumners
approved these changes
Feb 10, 2017
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
When I was reading through the docs, I didn't realize that some of the links in the README went to external files. Consequently, I just skipped it to skim the README, then ultimately opened an issue that I wouldn't have opened if I had clicked through to the API docs.
This PR introduces icons to the table of contents that may (?) help future developers recognize that these are external links.
For more on the motivation behind this, see #184 (comment) .
Feel free to close this if you don't think it'll help / think it's ugly. No worries.