Add a link to the actual Python docs at the start of README #100
Conversation
This file contains hidden or 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
Add a direct link to Python library documentation on readthedocs into the first section of the README.md. This is the section that many people see first when they google for pyimgui Python docs, so it's helpful to link to library user docs right away. I realize that the readthedocs link is already in the project description but at least I missed that completely and had to scroll many pages down to hit the readthedocs link. This is what many people looking at the github project will be looking for. Also drop "Cython-based" as IMO that doesn't help first time readers of this README.md get an idea of what this project is about. IMO "python bindings for ImGui" is more direct and informative.
|
That makes sense. Thanks for contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add a direct link to Python library documentation on readthedocs into
the first section of the README.md. This is the section that many
people see first when they google for pyimgui Python docs, so it's
helpful to link to library user docs right away.
I realize that the readthedocs link is already in the project
description but at least I missed that completely and had to scroll
many pages down to hit the readthedocs link. This is what many people
looking at the github project will be looking for.
Also drop "Cython-based" as IMO that doesn't help first time readers
of this README.md get an idea of what this project is about. IMO
"python bindings for ImGui" is more direct and informative.