Skip to content

Conversation

@oscarvalenzuelab
Copy link
Collaborator

Summary

This PR standardizes the src2purl README to match the consistent format used across SEMCL.ONE ecosystem projects.

Changes

  • Applied standardized README template with consistent structure
  • Added proper badges (AGPL-3.0 license, Python version, PyPI)
  • Condensed content to ~250 lines for better readability
  • Organized sections following PyPI documentation best practices
  • Preserved comprehensive technical content in logical sections
  • Removed emoji icons for professional documentation standards

Documentation Updates

  • Created missing documentation files referenced in README:
    • docs/user-guide.md - Comprehensive usage examples
    • docs/api.md - Python API documentation
    • docs/discovery-methods.md - Detailed identification strategies
    • docs/examples.md - Common use cases

Standards Applied

  • PyPI-compatible formatting
  • OSS best practices for documentation
  • Clear installation and usage instructions
  • Proper license attribution (AGPL-3.0)
  • SEMCL.ONE ecosystem integration details
  • No emoji icons for consistency

This brings src2purl in line with the documentation standards established for other SEMCL.ONE projects.

- Removed checkmark icons from API authentication section
- Maintains professional documentation standards
- Consistent with other SEMCL.ONE project documentation
@oscarvalenzuelab oscarvalenzuelab self-assigned this Nov 5, 2025
@oscarvalenzuelab oscarvalenzuelab merged commit 4ef3f6f into main Nov 5, 2025
7 checks passed
@oscarvalenzuelab oscarvalenzuelab deleted the feature/standardize-readme-v2 branch November 5, 2025 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants