docs: make the README user-friendly #273
Merged
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
epmog
force-pushed
the
update_readme
branch
4 times, most recently
from
966023e to
a3d8c02
Compare
marofke
previously approved these changes
Apr 1, 2024
moorec-aws
reviewed
Apr 1, 2024
epmog
commented
Apr 1, 2024
epmog
force-pushed
the
update_readme
branch
2 times, most recently
from
6b8b139 to
6d91b56
Compare
moorec-aws
previously approved these changes
Apr 1, 2024
ddneilson
previously approved these changes
Apr 1, 2024
Signed-off-by: Morgan Epp <[email protected]>
ddneilson
approved these changes
Apr 1, 2024
marofke
approved these changes
Apr 1, 2024
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.
What was the problem/requirement? (What/Why)
We are preparing for the first public release which includes publishing our distribution artifacts to PyPI. The description of the package on PyPI will include the
README.mdcontents of this repository. Any links in theREADME.mdthat are relative need to be made absolute since they will not resolve correctly on PyPI. When choosing the absolute link, the link must refer to the correct branch (mainlinevsrelease) depending on the context of the link.Additionally, once the repository becomes public, visitors will be looking for basic information about the project such as:
What was the solution? (How)
What is the impact of this change?
Readers landing on our published PyPI and GitHub pages will have a more clear and curated introduction to the project, emphasizing why they might find it important and providing information to help them get started using it and contributing to it.
How was this change tested?
Was this change documented?
This change is documentation :)
Is this a breaking change?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.