Add links to documentation pages from the REST API page #508
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.
Change
Adds a link to the general documentation pages which provide more context and also usage examples.
How to Test
Visit the API docs, look at the text at the top of the page.
Note that the link is to the GitHub pages, it does not reflect local changes to the documentation.
I guess we could do this through a configuration variable, but that seems unnecessary to me since we are currently not hosting our own pages (instead we use GitHub pages). When that changes (e.g., also to support dev docs), we can update.
Checklist
Related Issues
closes #452