docs: fix typos and improve README consistency - #238
Closed
varma1221 wants to merge 3 commits into
Closed
Conversation
### Summary This PR improves the AboutCode README by fixing small documentation issues and improving overall consistency and readability. ### Changes included * Fixed capitalization typos in the ScanCode LicenseDB section * Converted maintainer GitHub profile URLs to Markdown-linked usernames for better readability * Corrected minor grammar, spacing, and wording inconsistencies ### Scope This change is **documentation-only** and does not affect any code, behavior, or project configuration. ### Motivation The README is the main entry point for new users and contributors. These small cleanups help reduce friction, improve clarity, and make the document easier to scan and maintain. ### Notes No links, project ordering, or technical content were changed intentionally—this PR focuses purely on correctness and presentation.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 improves the AboutCode README by fixing small documentation issues and improving overall consistency and readability.
Changes included
Scope
This change is documentation-only and does not affect any code, behavior, or project configuration.
Motivation
The README is the main entry point for new users and contributors. These small cleanups help reduce friction, improve clarity, and make the document easier to scan and maintain.
Notes
No links, project ordering, or technical content were changed intentionally—this PR focuses purely on correctness and presentation.
Tasks
Run [tests](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html#continuous-integration) locally to check for errors.