Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARKNLP-1015] Restructuring Readme and Documentation #14341

Conversation

danilojsl
Copy link
Contributor

@danilojsl danilojsl commented Jul 6, 2024

Description

This PR focuses on restructuring the README and documentation to enhance clarity, organization, and accessibility.

Motivation and Context

  • Improved User Experience: Enhanced readability and navigability make it easier for users to find information.
  • Better Maintenance: Organized structure simplifies future updates and maintenance.
  • Increased Accessibility: Clear and comprehensive documentation ensures that users at all levels can understand and utilize spark-nlp effectively.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Code improvements with no or little impact
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING page.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@danilojsl danilojsl force-pushed the feature/SPARKNLP-1015-Modernizing-GitHub-repo branch 9 times, most recently from 6957c9d to 321b08a Compare July 6, 2024 15:52
@danilojsl danilojsl force-pushed the feature/SPARKNLP-1015-Modernizing-GitHub-repo branch from 321b08a to 1d440b7 Compare July 6, 2024 16:09
@danilojsl danilojsl self-assigned this Jul 8, 2024
@maziyarpanahi maziyarpanahi merged commit e120e61 into release/541-release-candidate Jul 14, 2024
1 check passed
@maziyarpanahi maziyarpanahi mentioned this pull request Jul 14, 2024
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