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.md contents of this repository. Any links in the README.md that 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 (mainline vs release) 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 is it?
what can it be used for?
how can it be used and operated?
how can people interact with the project?
What was the solution? (How)
Wrote it in VSCode with .md rendering
view in Github rendering
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?
Using Visual Studio Code's markdown preview feature
Reviewing GitHub's markdown rendered version
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.
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.