docs(#198): sync README and RTD index content for AboutCode overview and TOC #205
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
- Updated 'What is AboutCode?' and 'Projects' sections in README.md - Reflected the same updates in docs/index.rst to ensure consistency - Added GitHub Action to auto-sync README to RTD using rst format - Fulfills the proposal in issue aboutcode-org#198 for improving AboutCode TOC documentation Signed-off-by: Satyajeet Chavan <[email protected]>
satyajeetch1991
force-pushed
the
issue#198
branch
from
db6db91 to
3f61d67
Compare
|
review and merge it |
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 addresses issue #198 by updating and synchronizing the "What is AboutCode?" and "Projects" sections across the GitHub
README.mdand ReadTheDocsindex.rst. It ensures users see consistent and accurate documentation in both locations.Changes Made
docs/index.rstto mirror README overview and TOC structure.github/workflows/sync-readme-to-rst.ymlGitHub Action to automate Markdown to reStructuredText syncing (if needed in future)doc8styling checks pass locallyFixes
Fixes #198
✅ Checklist
🔏 Sign-Off
Contributed by @satyajeetch1991 as part of improving project documentation consistency.