Update AboutCode README and RTD Home Page for Consistency & Modernization #219
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
Signed-off-by: Sahil Sinha <[email protected]>
SinhaS12
force-pushed
the
update-readme-and-rtd
branch
from
605cd1a to
0575dc0
Compare
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.
This PR updates and synchronizes the AboutCode project overview across the GitHub README and the ReadTheDocs home page.
Goals of the PR
Bring README.md content up to date.
Ensure the RTD home page at
https://aboutcode.readthedocs.io/en/latest/index.html
reflects the same information with consistent structure and wording.
Modernize the description of AboutCode and explain the ecosystem clearly.
Fix typos, outdated descriptions, inconsistent formatting.
Provide a maintainable process for keeping README + RTD synced.