Standardize README format for PyPI and OSS best practices #42
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
- Created docs/user-guide.md with comprehensive usage examples - Created docs/api.md with Python API reference - Created docs/discovery-methods.md with detailed identification strategies - Created docs/examples.md with common use cases and workflows Documentation now matches README references
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.
Summary
This PR standardizes the src2purl README to match the consistent format used across SEMCL.ONE ecosystem projects.
Changes
Documentation Updates
Standards Applied
This brings src2purl in line with the documentation standards established for other SEMCL.ONE projects.