Add links to PDF.js homepage and API reference in README.md #10746
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
README.md
Outdated
| @@ -113,6 +113,10 @@ More learning resources can be found at: | |||
|
|
|||
| + https://github.com/mozilla/pdf.js/wiki/Additional-Learning-Resources | |||
|
|
|||
| ### API reference | |||
There was a problem hiding this comment.
Isn't this one level heading too deep, and also "reference" seems like a strange choice of word here...
Also, I'm not sure why the text from https://mozilla.github.io/pdf.js/api/ needs to be copied verbatim below either (since it adds even more links that may become stale).
Why not simply append the information to the list just above, e.g. something like this instead:
The API documentation can be found at:
+ https://mozilla.github.io/pdf.js/api/
There was a problem hiding this comment.
Added a commit with your suggested change, it fits much more nicely with the surrounding text.
timvandermeij
approved these changes
Apr 17, 2019
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Just a tiny quality-of-life change. I frequently find myself landing on the repo from search engines with no quick and visible way to go to the project homepage or API docs.