Include a link to documentation page in project URLs #766
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
The project.urls are picked up and displayed (with matching icons, if possible) by pypi.org. DataLad-next has its online documentation under docs.datalad.org and it is pretty good. Given that we already include a GitHub link in project.urls anyway (twice, in fact), it could be better to point Documentation to the online docs, rather than the GitHub README.
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.
The project.urls are picked up and displayed (with matching icons, if
possible) by pypi.org. DataLad-next has its online documentation under
docs.datalad.org and it is pretty good. Given that we already include
a GitHub link in project.urls anyway (twice, in fact), it could be
better to point Documentation to the online docs, rather than the
GitHub README.
What do you think?
Side note: I would even be tempted to remove the Homepage link and
only keep Source (currently they are the same and point to the GitHub
project), but I wasn't sure if the Homepage is considered necessary or
not, and hence didn't include it in the original proposal.